Show not everything
log
action_wheel
Miscellaneous Types
Miscellaneous Enums
Colors EntityPoses ItemRenderTypes KeyIDs Keybinds LoopModes ParentTypes PlayStates PostEffects RenderTypes TextureTypeslogJson
Example by ChloeSpacedOut:
logJson('{"text":"meow ^^","color":"#a672ef"}')
logTable
An alias for printTable().
A function that writes its arguments to chat. Even though the syntax says only one argument, you can put as many as you want. All of them will print, and they'll be separated by some spaces.
printJson
Example by ChloeSpacedOut:
printJson('{"text":"meow ^^","color":"#a672ef"}')
printTable
Example by ChloeSpacedOut:
local table = {'string',{'tableception'}}
printTable(table,2)
The first argument is either a Table, or it's a Userdata, which refers to any of the added Figura types. Prints the table out to chat, specially formatted. If userdata is passed in, it is automatically converted to a table or string, and displayed. In the case of tables inside of tables, the "maxDepth" parameter will be used to determine how far to go. BE CAREFUL WITH RECURSIVE TABLES! If you try to print a table too deeply, then your game may freeze while it calculates everything to print, and you may have to restart your client if you go too crazy with it. Default value for maxDepth is 1.
require
Example by ChloeSpacedOut:
local library = require("lib.parser")
-- this will import a file
The require() function takes the name of one of your scripts, without the .lua extension. If this script has not been already run before, it will run that script and return the value that script returns. If it has been run before, then it will not run the file again, but it will return the same thing as the first time. If a required script has no returns, then require() will return true. If the name you give isn't any of your scripts, it will error.
action_wheel
The global instance of the ActionWheelAPI and its subtypes.
field signature:
action_wheel
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | an ActionWheelAPI | ActionWheelAPI
|
ActionWheelAPI.execute
Example by ChloeSpacedOut:
examplePage = action_wheel:createPage()
action_wheel:setPage(examplePage)
examplePage:newAction(1):onRightClick(function() log('chat spam :3') end)
events.TICK:register(function()
action_wheel:execute(1,true)
end)
-- this will only run if the action wheel is open
Executes the action of the given index. If the index is null, it will execute the last selected action. A second parameter can be given to specify if it should be executed the left or right action.
overload 1:
action_wheel:execute()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | nil | nil
|
ActionWheelAPI.isEnabled
Example by ChloeSpacedOut:
examplePage = action_wheel:createPage()
action_wheel:setPage(examplePage)
events.TICK:register(function()
if action_wheel:isEnabled() then
log("action wheel's is open!")
end
end)
Returns if the Action Wheel is being currently rendered or not.
overload 1:
action_wheel:isEnabled()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
ActionWheelAPI.getSelected
Example by ChloeSpacedOut:
examplePage = action_wheel:createPage()
action_wheel:setPage(examplePage)
for slot = 1,8 do
examplePage:newAction(slot)
end
events.TICK:register(function()
log(action_wheel:getSelected())
end)
-- returns even if the action wheel is closed
Returns the index of the currently selected action.
overload 1:
action_wheel:getSelected()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
ActionWheelAPI.createPage
Example by ChloeSpacedOut:
action_wheel:createPage('examplePage')
Creates a new Page for the action wheel. A Title can be given to store this page internally. If no Title is given, the Page will just be returned from this function.
ActionWheelAPI.setPage
Example by ChloeSpacedOut:
examplePage = action_wheel:createPage()
action_wheel:setPage(examplePage)
Sets the Page of the action wheel to the given Title or Page.
ActionWheelAPI.getPage
Example by ChloeSpacedOut:
action_wheel:createPage('examplePage')
log(action_wheel:getPage('examplePage'))
ActionWheelAPI.leftClick
Example by ChloeSpacedOut:
examplePage = action_wheel:createPage('pageName')
action_wheel:setPage(examplePage)
function action_wheel.leftClick()
log('you just left clicked while in the action wheel!')
end
Function that is executed when the left mouse button is clicked.
field signature:
leftClick
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Function | Function
|
ActionWheelAPI.rightClick
Example by ChloeSpacedOut:
examplePage = action_wheel:createPage('pageName')
action_wheel:setPage(examplePage)
function action_wheel.rightClick()
log('you just left clicked while in the action wheel!')
end
Function that is executed when the right mouse button is clicked.
field signature:
rightClick
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Function | Function
|
ActionWheelAPI.scroll
Example by ChloeSpacedOut:
examplePage = action_wheel:createPage('pageName')
action_wheel:setPage(examplePage)
function action_wheel.scroll(direction)
log(direction)
end
Function that is executed when the mouse is scrolled.
field signature:
scroll
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Function | Function
|
animations
The global instance of the "animations" table and its subtypes.
field signature:
animations
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a table | Table
|
avatar
The global instance of AvatarAPI.
field signature:
avatar
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | an AvatarAPI | AvatarAPI
|
AvatarAPI.getName
Gets the name string of this avatar.
overload 1:
avatar:getName()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
AvatarAPI.store
Store the given key-value pair inside your current avatar's metadata. Someone else can get this information from a different script with the playerVars() function in World. The key must be a string.
AvatarAPI.getSize
Gets the file size of this avatar in bytes.
overload 1:
avatar:getSize()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
AvatarAPI.getVersion
Gets the version string of this avatar.
overload 1:
avatar:getVersion()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
AvatarAPI.setColor
Sets the current color string of your avatar, used as your avatar theme.
AvatarAPI.getAuthors
Gets the authors string of this avatar.
overload 1:
avatar:getAuthors()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
AvatarAPI.getCurrentInstructions
Gets the current number of instructions that have been executed by your avatar. Resets to 0 at the beginning of certain events.
overload 1:
avatar:getCurrentInstructions()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
AvatarAPI.getMaxWorldRenderCount
Gets the maximum allowed instructions in Events.WORLD_RENDER and Events.POST_WORLD_RENDER in the trust settings of the viewer.
overload 1:
avatar:getMaxWorldRenderCount()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
AvatarAPI.getWorldRenderCount
Gets the number of Events.WORLD_RENDER and Events.POST_WORLD_RENDER instructions of this avatar last frame.
overload 1:
avatar:getWorldRenderCount()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
AvatarAPI.getMaxAnimationComplexity
Gets the maximum allowed animation complexity (number of playing channels) in the trust settings of the viewer.
overload 1:
avatar:getMaxAnimationComplexity()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
AvatarAPI.getRemainingParticles
Gets the remaining amount of particles this avatar can summon.
overload 1:
avatar:getRemainingParticles()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
AvatarAPI.getAnimationComplexity
Gets the current animation complexity of this avatar.
overload 1:
avatar:getAnimationComplexity()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
AvatarAPI.canEditVanillaModel
Gets whether or not the viewer allows your avatar to edit the vanilla models.
overload 1:
avatar:canEditVanillaModel()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
AvatarAPI.getMaxWorldTickCount
Gets the maximum allowed instructions in Events.WORLD_TICK in the trust settings of the viewer.
overload 1:
avatar:getMaxWorldTickCount()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
AvatarAPI.getComplexity
Gets the current complexity of this avatar.
overload 1:
avatar:getComplexity()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
AvatarAPI.getColor
Gets the current color string of your avatar, used as your avatar theme.
overload 1:
avatar:getColor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
AvatarAPI.hasTexture
Gets whether or not this avatar has a texture.
overload 1:
avatar:hasTexture()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
AvatarAPI.getMaxTickCount
Gets the maximum allowed instructions in Events.TICK in the trust settings of the viewer.
overload 1:
avatar:getMaxTickCount()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
AvatarAPI.getWorldTickCount
Gets the number of Events.WORLD_TICK instructions of this avatar last tick.
overload 1:
avatar:getWorldTickCount()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
AvatarAPI.getRemainingSounds
Gets the remaining amount of sound this avatar can play.
overload 1:
avatar:getRemainingSounds()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
AvatarAPI.getMaxSounds
Gets the maximum allowed number of sounds in the trust settings of the viewer.
overload 1:
avatar:getMaxSounds()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
AvatarAPI.getMaxInitCount
Gets the maximum allowed instructions during initialization in the trust settings of the viewer.
overload 1:
avatar:getMaxInitCount()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
AvatarAPI.getInitCount
Gets the number of initialization instructions of this avatar.
overload 1:
avatar:getInitCount()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
AvatarAPI.getMaxComplexity
Gets the maximum allowed model complexity (number of faces) in the trust settings of the viewer.
overload 1:
avatar:getMaxComplexity()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
AvatarAPI.getEntityInitCount
Gets the number of Events.ENTITY_INIT instructions of this avatar.
overload 1:
avatar:getEntityInitCount()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
AvatarAPI.getMaxParticles
Gets the maximum allowed number of particles in the trust settings of the viewer.
overload 1:
avatar:getMaxParticles()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
AvatarAPI.getMaxRenderCount
Gets the maximum allowed instructions in Events.RENDER and Events.POST_RENDER in the trust settings of the viewer.
overload 1:
avatar:getMaxRenderCount()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
AvatarAPI.getTickCount
Gets the number of Events.TICK instructions of this avatar last tick.
overload 1:
avatar:getTickCount()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
AvatarAPI.getRenderCount
Gets the number of Events.RENDER and Events.POST_RENDER instructions of this avatar last frame.
overload 1:
avatar:getRenderCount()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
AvatarAPI.hasScriptError
Gets whether this script currently has stopped due to an error (kinda useless lmao).
overload 1:
avatar:hasScriptError()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
AvatarAPI.canRenderOffscreen
Gets whether or not the viewer trusts you to render the avatar off-screen.
overload 1:
avatar:canRenderOffscreen()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
AvatarAPI.canUseCustomSounds
Gets whether or not the viewer allows your avatar to play custom sounds.
overload 1:
avatar:canUseCustomSounds()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
AvatarAPI.canEditNameplate
Gets whether or not the viewer allows your avatar to edit your nameplate.
overload 1:
avatar:canEditNameplate()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
client
The global instance of ClientAPI.
field signature:
client
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a ClientAPI | ClientAPI
|
ClientAPI.getVersion
Example by ChloeSpacedOut:
log(client.getVersion())
Returns the "version" of your client. In testing, this returned "Fabric".
overload 1:
client.getVersion()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ClientAPI.isDebugOverlayEnabled
Returns true if the F3 screen is currently open.
overload 1:
client.isDebugOverlayEnabled()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
ClientAPI.getEntityStatistics
Example by ChloeSpacedOut:
log(client.getEntityStatistics())
-- Number of rendered entities / total entities, 0, simulation distance
Returns a string containing information about the loaded entities on the client. This string appears in the F3 menu.
overload 1:
client.getEntityStatistics()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ClientAPI.getScaledWindowSize
Returns the size of the window in Minecraft's interal GUI units.
overload 1:
client.getScaledWindowSize()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector2 | Vector2
|
ClientAPI.getEntityCount
Returns the number of currently loaded entities.
overload 1:
client.getEntityCount()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
ClientAPI.getJavaVersion
Example by ChloeSpacedOut:
log(client.getJavaVersion())
Returns your current Java version you're playing Minecraft with.
overload 1:
client.getJavaVersion()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ClientAPI.getServerBrand
Example by ChloeSpacedOut:
log(client.getServerBrand())
Returns the type of server you're on. In singleplayer, this is "Integrated".
overload 1:
client.getServerBrand()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ClientAPI.getSoundStatistics
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getSoundStatistics())
end)
-- sounds playing / sounds limit + ambient sounds playing / ambient sounds limit
Returns a string containing information about the currently playing sounds on the client. This string appears in the F3 menu.
overload 1:
client.getSoundStatistics()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ClientAPI.getUsedMemory
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getUsedMemory())
end)
-- returns memory in bytes
Returns the number of bytes of memory Minecraft is currently using.
overload 1:
client.getUsedMemory()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
ClientAPI.getMaxMemory
Example by ChloeSpacedOut:
log(client.getMaxMemory())
-- returns memory in bytes
Returns the maximum amount of memory that Minecraft will try to use.
overload 1:
client.getMaxMemory()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
ClientAPI.getFPS
Gets the FPS of the client. Returns 0 if the fps counter isn't ready yet (or if your pc is just that bad).
overload 1:
client.getFPS()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
ClientAPI.getVersionType
Example by ChloeSpacedOut:
log(client.getVersionType())
Returns the "version type" of your client. In testing, this returned "Fabric".
overload 1:
client.getVersionType()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ClientAPI.hasIris
Checks if the client has the Iris mod installed.
overload 1:
client.hasIris()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
ClientAPI.getFPSString
Gets the FPS string of the client, displayed in the F3 menu. Contains info on the fps, the fps limit, vsync, cloud types, and biome blend radius.
overload 1:
client.getFPSString()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ClientAPI.getChunkStatistics
Example by ChloeSpacedOut:
log(client.getChunkStatistics())
-- Number of chunk sections rendered / the total number of chunk sections in the loaded area
Returns a string containing information about the player's chunk. This string appears in the F3 menu.
overload 1:
client.getChunkStatistics()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ClientAPI.getParticleCount
Returns the number of currently loaded particles.
overload 1:
client.getParticleCount()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ClientAPI.getFiguraVersion
Gets the client Figura version.
overload 1:
client.getFiguraVersion()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ClientAPI.getGuiScale
Example by ChloeSpacedOut:
log(client.getGuiScale())
Returns the current value of your Gui Scale setting. If you use auto, then it gets the actual current scale.
overload 1:
client.getGuiScale()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
ClientAPI.getTextHeight
Example by ChloeSpacedOut:
log(client.getTextHeight('TEXT!'))
ClientAPI.getTextWidth
Example by ChloeSpacedOut:
log(client.getTextWidth('TEXT!'))
ClientAPI.getActiveLang
Example by ChloeSpacedOut:
log(client.getActiveLang())
Returns a string representation of the current game language.
overload 1:
client.getActiveLang()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ClientAPI.getMousePos
Returns the position of the mouse in pixels, relative to the top-left corner.
overload 1:
client.getMousePos()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector2 | Vector2
|
ClientAPI.isHudEnabled
Returns true if the hud is enabled (F1 disables the HUD).
overload 1:
client.isHudEnabled()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
ClientAPI.getSystemTime
Returns the current system time in milliseconds.
overload 1:
client.getSystemTime()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
ClientAPI.getCameraRot
Returns the rotation of the viewer's camera.
overload 1:
client.getCameraRot()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
ClientAPI.getWindowSize
Returns the size of the Minecraft window in pixels, as {width, height}.
overload 1:
client.getWindowSize()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector2 | Vector2
|
ClientAPI.isWindowFocused
Returns true if the Minecraft window is currently focused.
overload 1:
client.isWindowFocused()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
ClientAPI.getFOV
Returns the current FOV option of the client, not including additional effects such as speed or sprinting.
overload 1:
client.getFOV()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
ClientAPI.getAllocatedMemory
Example by ChloeSpacedOut:
log(client.getAllocatedMemory())
-- returns memory in bytes
Returns the maximum amount of memory that Minecraft can possibly use.
overload 1:
client.getAllocatedMemory()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
ClientAPI.hasIrisShader
Checks if the client is currently using an Iris shader.
overload 1:
client.hasIrisShader()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
ClientAPI.getCameraPos
Returns the position of the viewer's camera.
overload 1:
client.getCameraPos()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
events
The global instance of the EventsAPI and its subtypes.
field signature:
events
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | an EventsAPI | EventsAPI
|
EventsAPI.ENTITY_INIT
The ENTITY_INIT event is run once this avatar's entity exists.
field signature:
ENTITY_INIT
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | an Event | Event
|
EventsAPI.TICK
The TICK event is run every tick in-game if this avatar's entity exists.
EventsAPI.WORLD_TICK
The WORLD_TICK event is run every in-game tick.
field signature:
WORLD_TICK
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | an Event | Event
|
EventsAPI.RENDER
The RENDER event is run every frame, before the avatar is rendered. Takes a parameter delta, which is a number from 0 to 1 indicating the proportion of the way the game is between ticks.
EventsAPI.POST_RENDER
The POST_RENDER event runs every frame, after the avatar is rendered. Takes a parameter delta, which is a number from 0 to 1 indicating the proportion of the way the game is between ticks.
field signature:
POST_RENDER
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | an Event | Event
|
EventsAPI.WORLD_RENDER
The WORLD_RENDER event is run every frame, before the world is rendered. Always runs when a world is visible, even when the avatar itself is not, so this runs even in first person. Takes a parameter delta, which is a number from 0 to 1 indicating the proportion of the way the game is between ticks.
field signature:
WORLD_RENDER
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | an Event | Event
|
EventsAPI.POST_WORLD_RENDER
The POST_WORLD_RENDER event runs every frame, after the world is rendered. Always runs when a world is visible, even when the avatar itself is not, so this runs even in first person. Takes a parameter delta, which is a number from 0 to 1 indicating the proportion of the way the game is between ticks.
field signature:
POST_WORLD_RENDER
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | an Event | Event
|
EventsAPI.CHAT_SEND_MESSAGE
The CHAT_SEND_MESSAGE event is run every time you send a message in chat. A string parameter is passed in, which contains the message that was sent.
field signature:
CHAT_SEND_MESSAGE
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | an Event | Event
|
EventsAPI.CHAT_RECEIVE_MESSAGE
The CHAT_RECEIVE_MESSAGE event is run every time a message is received in chat. A string parameter is passed in, which contains the message you received.
field signature:
CHAT_RECEIVE_MESSAGE
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | an Event | Event
|
EventsAPI.SKULL_RENDER
Called between POST_RENDER and POST_WORLD_RENDER, on every one of your skull blocks placed in the world. The arguments are the tick delta and the position of the skull as a vector.
field signature:
SKULL_RENDER
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | an Event | Event
|
EventsAPI.MOUSE_SCROLL
The MOUSE_SCROLL event runs every time the mouse is scrolled. Takes a parameter delta, which is the direction of the scroll.
field signature:
MOUSE_SCROLL
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | an Event | Event
|
figuraMetatables
A table containing all the metatables for Figura's object types. The metatables are editable.
field signature:
figuraMetatables
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a table | Table
|
host
The global instance of HostAPI.
field signature:
host
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a HostAPI | HostAPI
|
HostAPI.isHost
Returns true if this instance of the script is running on host.
overload 1:
host:isHost()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
HostAPI.clearTitle
Clears the current title from the GUI.
overload 1:
host:clearTitle()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | nil | nil
|
HostAPI.setTitleTimes
Sets the duration of the title on the screen, also its fade-in and fade-out durations.
HostAPI.setActionbar
Sets the action bar message to the given text. The boolean parameter defaults to false.
HostAPI.swingArm
Animates swinging the player's arm. If the boolean is true, then the offhand is the one that swings.
HostAPI.getTargetedEntity
Returns a proxy for your currently targeted entity. This entity appears on the F3 screen.
overload 1:
host:getTargetedEntity()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an EntityAPI | EntityAPI
|
HostAPI.isChatOpen
Checks if the host has the chat screen opened.
overload 1:
host:isChatOpen()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
HostAPI.isContainerOpen
Checks if the host has a container screen opened.
overload 1:
host:isContainerOpen()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
HostAPI.getChatText
Gets the text that is currently being typed into the chat window.
overload 1:
host:getChatText()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
HostAPI.setChatColor
Sets the color of the text that is currently being typed into the chat window.
HostAPI.getChatColor
Gets the chat window text color.
overload 1:
host:getChatColor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
HostAPI.unlockCursor
Setting this value to true will unlock your cursor, letting you move it freely on the screen instead of it controlling your player's rotation.
field signature:
unlockCursor
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Boolean | Boolean
|
keybind
The global instance of the KeybindAPI and its subtypes.
field signature:
keybind
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a KeybindAPI | KeybindAPI
|
KeybindAPI.create
Creates and returns a new Keybind. The name is used in the keybind menu. The key parameter is an identifier for a key, such as "key.keyboard.r". The boolean gui indicates whether the keybind should always work, or if it should only work when you don't have a screen open. Check the docs list command for all key names.
matrices
The global instance of the MatricesAPI and its subtypes.
field signature:
matrices
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a MatricesAPI | MatricesAPI
|
MatricesAPI.scale2
Creates a new Matrix2 that scales by the specified factors.
MatricesAPI.mat3
Creates a Matrix3 using the given parameters as columns. If you call the function with no parameters, returns the 3x3 identity matrix.
overload 1:
matrices.mat3()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix3 | Matrix3
|
MatricesAPI.mat4
Creates a Matrix4 using the given parameters as columns. If you call the function with no parameters, returns the 4x4 identity matrix.
overload 1:
matrices.mat4()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix4 | Matrix4
|
MatricesAPI.mat2
Creates a Matrix2 using the given parameters as columns. If you call the function with no parameters, returns the 2x2 identity matrix.
MatricesAPI.rotation3
Creates a new Matrix3 that rotates by the specified angles. Angles are given in degrees, and the rotation order is ZYX.
MatricesAPI.scale4
Creates a new Matrix4 that scales by the specified factors.
MatricesAPI.rotation4
Creates a new Matrix4 that rotates by the specified angles. Angles are given in degrees, and the rotation order is ZYX.
MatricesAPI.scale3
Creates a new Matrix3 that scales by the specified factors.
MatricesAPI.translate3
Creates a new Matrix3 that translates by the specified offset.
MatricesAPI.translate4
Creates a new Matrix4 that translates by the specified offset.
models
The global instance of the Avatar Models and its subtypes.
field signature:
models
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a ModelPart | ModelPart
|
ModelPart.getName
The name of this model part.
overload 1:
models:getName()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ModelPart.getType
Returns whether this part is a "GROUP", a "CUBE", or a "MESH".
overload 1:
models:getType()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ModelPart.getChildren
Gets the children of this part, stored in a table.
overload 1:
models:getChildren()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an array of a ModelPart | ModelPart
[
]
|
ModelPart.setColor
Sets the color multiplier for this part. Values are RGB from 0 to 1. Default values are 1, indicating white/no color change.
ModelPart.setScale
Sets the scale factor for this part. Nil values for scale are assumed to be 1.
ModelPart.addItem
Adds a new Item Render Task on this part.
overload 1:
models:addItem(taskName)
| Method Property | Fluent Description | Representation |
|---|---|---|
| taskName accepts | a string | String
|
| Return Value | a RenderTask | RenderTask
|
ModelPart.getAnimScale
Gets the scale multiplier provided by the currently active animation of this model part.
overload 1:
models:getAnimScale()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
ModelPart.getTask
Gets the Render Task with the given name from this part.
overload 1:
models:getTask()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a table mapping a string to a RenderTask | Table
<
String
,
RenderTask
>
|
overload 2:
models:getTask(taskName)
| Method Property | Fluent Description | Representation |
|---|---|---|
| taskName accepts | a string | String
|
| Return Value | a RenderTask | RenderTask
|
ModelPart.getScale
Gets the scale of the model part, as a multiple of its blockbench size. Only changes from {1,1,1} when you call setScale().
overload 1:
models:getScale()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
ModelPart.getPos
Gets the position of the model part, as an offset from its position in blockbench. Only changes from {0,0,0} when you call setPos().
overload 1:
models:getPos()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
ModelPart.setPos
Sets the position offset for this part from its blockbench position. Nil values for position are assumed to be 0.
ModelPart.getOpacity
Gets the opacity multiplier of this part. Note that opacity settings will only take effect if the part has a suitable Render Type for them, mainly TRANSLUCENT. Check out modelPart.setPrimaryRenderType() for how to do this.
overload 1:
models:getOpacity()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
ModelPart.offsetPivot
Sets the offset pivot point for this part. Nil values are assumed to be 0. For absolute pivot point values, check out the non-offset pivot functions.
ModelPart.getPivot
Gets the pivot point of the model part, including its pivot in blockbench. For relative values, check out the "offset" pivot functions.
overload 1:
models:getPivot()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
ModelPart.offsetRot
Sets the offset rotation for this part. Nil values for rotation are assumed to be 0. Angles are given in degrees. For absolute rotation values, check out the non-offset rot functions.
ModelPart.getAnimPos
Gets the position offset provided by the currently active animation of this model part.
overload 1:
models:getAnimPos()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
ModelPart.setMatrix
Sets the given matrix as the position matrix for this model part. The normal matrix is automatically calculated as the inverse transpose of this matrix. Calling this DOES NOT CHANGE the values of position, rot, or scale in the model part. If you call setPos() or a similar function, the effects of setMatrix() will be overwritten.
ModelPart.getOffsetPivot
Gets the offset pivot of the model part, offset from its pivot in blockbench. For absolute pivot point values, check out the non-offset pivot functions.
overload 1:
models:getOffsetPivot()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
ModelPart.getAnimRot
Gets the rotation offset provided by the currently active animation of this model part.
overload 1:
models:getAnimRot()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
ModelPart.setRot
Sets the absolute rotation for this part. Nil values for rotation are assumed to be 0. Angles are given in degrees. For relative rotation values, check out the "offset" rot functions.
ModelPart.getNormalMatrixRaw
Returns the normal matrix for this model part. The Raw version of the function is different in that it doesn't recalculate the matrix before returning it.
overload 1:
models:getNormalMatrixRaw()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix3 | Matrix3
|
ModelPart.getRot
Gets the rotation of the model part, including its rotation in blockbench. For relative rotation values, check out the "offset" rot functions.
overload 1:
models:getRot()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
ModelPart.getPositionMatrix
Recalculates the matrix for this model part, based on its current position, rotation, scale, and pivot, then returns this matrix.
overload 1:
models:getPositionMatrix()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix4 | Matrix4
|
ModelPart.getNormalMatrix
Recalculates the normal matrix for this model part, based on its current position, rotation, scale, and pivot, then returns this matrix.
overload 1:
models:getNormalMatrix()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix3 | Matrix3
|
ModelPart.setPivot
Sets the absolute pivot for this part. Nil values are assumed to be 0. For relative pivot offsets, check out the "offset" pivot functions.
ModelPart.setPrimaryTexture
Sets the primary texture override of this part. Check the TextureType types in the list docs. If using "resource", the second parameter should indicate the path to the Minecraft texture you want to use.
ModelPart.getOffsetRot
Gets the offset rotation of the model part, offset from its rotation in blockbench. For absolute rotation values, check out the non-offset rot functions.
overload 1:
models:getOffsetRot()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
ModelPart.setLight
Sets the light level to be used when rendering this part. Values you give are 0 to 15, indicating the block light and sky light levels you want to use. Passing nil will reset the lighting override for this part.
ModelPart.setUVMatrix
Sets the UV matrix of this part. This matrix is applied to all UV points during the transform, with the UVs treated as homogeneous vectors. setUV() and setUVPixels() are actually just simpler ways of setting this matrix.
ModelPart.setOpacity
Sets the opacity multiplier of this part. Note that opacity settings will only take effect if the part has a suitable Render Type for them, mainly TRANSLUCENT. Check out modelPart.setPrimaryRenderType() for how to do this.
ModelPart.partToWorldMatrix
Gets a matrix which transforms a point from this part's position to a world location. Recommended to use this in POST_RENDER, as by then the matrix is updated. In RENDER it will be 1 frame behind the part's visual position for that frame. Also, if the model is not rendered in-world, the part's matrix will not be updated. Paperdoll rendering and other UI rendering will not affect this matrix.
overload 1:
models:partToWorldMatrix()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix4 | Matrix4
|
ModelPart.setUVPixels
Sets the UV of this part in pixels. Automatically divides by the results of getTextureSize(), so you can just input the number of pixels you want the UV to scroll by. Errors if the part has multiple different-sized textures.
ModelPart.setUV
Sets the UV of this part. This function is normalized, meaning it works with values 0 to 1. If you say setUV(0.5, 0.25), for example, it will scroll by half of your texture width to the right, and one fourth of the texture width downwards.
ModelPart.getLight
Gets the light level you set earlier to this part. Does not interact with Minecraft's lighting system, only retrieving values you set earlier with setLight().
overload 1:
models:getLight()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector2 | Vector2
|
ModelPart.getTextureSize
Gets the width, height of this part's texture in pixels. If this part has multiple different-sized textures on it, it throws an error instead.
overload 1:
models:getTextureSize()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector2 | Vector2
|
ModelPart.addText
Adds a new Text Render Task on this part.
overload 1:
models:addText(taskName)
| Method Property | Fluent Description | Representation |
|---|---|---|
| taskName accepts | a string | String
|
| Return Value | a RenderTask | RenderTask
|
ModelPart.getParentType
Returns the current parent type of the part.
overload 1:
models:getParentType()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ModelPart.addBlock
Adds a new Block Render Task on this part.
overload 1:
models:addBlock(taskName)
| Method Property | Fluent Description | Representation |
|---|---|---|
| taskName accepts | a string | String
|
| Return Value | a RenderTask | RenderTask
|
ModelPart.getPositionMatrixRaw
Returns the position matrix for this model part. The Raw version of the function is different in that it doesn't recalculate the matrix before getting it.
overload 1:
models:getPositionMatrixRaw()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix4 | Matrix4
|
ModelPart.getSecondaryRenderType
Gets the current secondary render type of this model part. Nil by default, meaning the part copies the secondary render type of its parent.
overload 1:
models:getSecondaryRenderType()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | either a RenderTypes or nil | RenderTypes
|
nil
|
ModelPart.setPrimaryRenderType
Sets the current primary render type of this model part. Nil by default, meaning the part copies the primary render type of its parent during rendering. Check the docs list command for all render types.
ModelPart.setSecondaryRenderType
Sets the current secondary render type of this model part. Nil by default, meaning the part copies the secondary render type of its parent during rendering. Check the docs list command for all render types.
ModelPart.getPrimaryRenderType
Gets the current primary render type of this model part. Nil by default, meaning the part copies the primary render type of its parent.
overload 1:
models:getPrimaryRenderType()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | either a RenderTypes or nil | RenderTypes
|
nil
|
ModelPart.setSecondaryTexture
Sets the secondary texture override of this part. Check the TextureType types in the list docs. If using "resource", the second parameter should indicate the path to the Minecraft texture you want to use.
ModelPart.getColor
Gets the color multiplier of this part. Values are RGB from 0 to 1. Default values are 1, indicating white/no color change.
overload 1:
models:getColor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
nameplate
The global instance of the NameplateAPI and its subtypes.
field signature:
nameplate
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a NameplateAPI | NameplateAPI
|
NameplateAPI.CHAT
A customization for your nameplate in the chat.
field signature:
CHAT
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a NameplateCustomization | NameplateCustomization
|
NameplateAPI.ENTITY
A customization for your nameplate above your head.
field signature:
ENTITY
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | an EntityNameplateCustomization | EntityNameplateCustomization
|
NameplateAPI.LIST
A customization for your nameplate in the tab list.
field signature:
LIST
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a NameplateCustomization | NameplateCustomization
|
NameplateAPI.ALL
A group that manage all your nameplate customizations at once.
field signature:
ALL
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a NameplateCustomizationGroup | NameplateCustomizationGroup
|
particles
The global instance of ParticleAPI.
field signature:
particles
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a ParticleAPI | ParticleAPI
|
ParticleAPI.addParticle
Creates a particle with the given name at the specified position, with the given velocity. Some particles have special properties, like the "dust" particle. For these particles, the special properties can be put into the "name" parameter, the same way as it works for commands.
overload 7:
particles:addParticle(name, posX, posY, posZ, velX, velY, velZ)
player
The global instance of the EntityAPI and its subtypes.
field signature:
player
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a PlayerAPI | PlayerAPI
|
PlayerAPI.getSaturation
Example by JimmyHelp:
if player:getSaturation() == 20 then
log("Your saturation is 20")
end
Gets the current saturation level of the player.
overload 1:
player:getSaturation()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
PlayerAPI.getExperienceLevel
Example by JimmyHelp:
if player:getExperienceLevel() == 30 then
log("You have 30 levels")
end
Gets the player's current level.
overload 1:
player:getExperienceLevel()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
PlayerAPI.isFlying
Example by JimmyHelp:
if player:isFlying() then
log("You're flying")
end
Returns whether the player is currently flying.
overload 1:
player:isFlying()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
PlayerAPI.getFood
Example by JimmyHelp:
if player:getFood() == 0 then
log("You're starving")
end
Gets the current food level of the player, from 0 to 20.
overload 1:
player:getFood()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
PlayerAPI.getModelType
Example by JimmyHelp:
if player:getModelType() == "DEFAULT" then
log("You're Steve")
end
Returns "SLIM" or "DEFAULT", depending on the player's model type.
overload 1:
player:getModelType()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
PlayerAPI.getGamemode
Example by JimmyHelp:
if player:getGamemode() and player:getGamemode() == "SURVIVAL" then
log("You're in survival mode")
end
PlayerAPI.getExperienceProgress
Example by JimmyHelp:
if player:getExperienceProgress() > .5 then
log("You're over halfway to the next level")
end
Gets the progress of the way towards the player's next level, as a value from 0 to 1.
overload 1:
player:getExperienceProgress()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
PlayerAPI.getBodyYaw
Inherited from LivingEntityAPI
Example by JimmyHelp:
models:setRot(0,player:getBodyYaw())
Gets the yaw of this entity's body in degrees. If delta is passed in, then it will be used to linearly interpolate the rotation of the body between the previous tick and the current tick. The default value of delta is 1.
PlayerAPI.getHeldItem
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getHeldItem(false).id == "minecraft:diamond_sword" then
log("You're holding a diamond sword")
end
Returns an ItemStack representing the item in this entity's main hand. If true is passed in for "offhand", then it will instead look at the item in the entity's offhand. If the entity isn't holding an item in that hand, returns nil.
PlayerAPI.getActiveItem
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getActiveItem().id == "minecraft:bow" then
log("You're drawing back a bow")
end
Returns an ItemStack representing the item the entity is currently using. If they're not using any item, returns nil.
overload 1:
player:getActiveItem()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an ItemStack | ItemStack
|
PlayerAPI.getDeathTime
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getDeathTime() > 0 then
log("You're dead")
end
Returns the number of ticks this entity has been dead for.
overload 1:
player:getDeathTime()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
PlayerAPI.isClimbing
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isClimbing() then
log("You're climbing")
end
Returns true if the entity is currently using a climbable block, like a ladder or vine.
overload 1:
player:isClimbing()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
PlayerAPI.isUsingItem
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isUsingItem() then
log("You're using an item")
end
Returns true if the entity is currently using an item.
overload 1:
player:isUsingItem()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
PlayerAPI.getStingerCount
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getStingerCount() > 0 then
log("You've been stung")
end
Returns the number of bee stingers sticking out of this entity.
overload 1:
player:getStingerCount()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
PlayerAPI.isLeftHanded
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isLeftHanded() then
log("You're left handed")
end
Returns true if the entity's main hand is its left.
overload 1:
player:isLeftHanded()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
PlayerAPI.getArmor
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getArmor() == 20 then
log("You have max armor points")
end
Returns the amount of armor points this entity has.
overload 1:
player:getArmor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
PlayerAPI.getHealth
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getHealth() == 20 then
log("You're at full health")
end
Returns the amount of health this entity has remaining.
overload 1:
player:getHealth()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
PlayerAPI.getStatusEffects
Inherited from LivingEntityAPI
Example by JimmyHelp:
for i, effect in ipairs(player:getStatusEffects()) do
if effect.name == "effect.minecraft.night_vision" then
log("Night vision")
end
end
Returns, as a table, all of the status effects this entity has on it. The table contains sub-tables, each of which contains the name, amplifier, duration, and particle visibility of an effect this entity has.
overload 1:
player:getStatusEffects()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a table | Table
|
PlayerAPI.getArrowCount
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getArrowCount() > 0 then
log("You've been shot")
end
Returns the number of arrows sticking out of this entity.
overload 1:
player:getArrowCount()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
PlayerAPI.getActiveHand
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getActiveHand() == "MAIN_HAND" then
log("You're using your main hand")
end
Returns "OFF_HAND" or "MAIN_HAND", depending on which hand this entity uses an item with.
overload 1:
player:getActiveHand()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
PlayerAPI.getMaxHealth
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getMaxHealth() == 20 then
log("You're healthy")
end
Returns the maximum amount of health this entity can have.
overload 1:
player:getMaxHealth()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
PlayerAPI.getName
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getName() == "JimmyHelp" then
log("You're... me?")
end
Gets the name of this entity, if it has a custom name. If it doesn't, returns a translated form of getType().
overload 1:
player:getName()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
PlayerAPI.getType
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getType() == "minecraft:player" then
log("You're a player")
end
Gets the Minecraft identifier of this entity. For instance, "minecraft:pig".
overload 1:
player:getType()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
PlayerAPI.isLoaded
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isLoaded() then
log("You're being loaded")
end
Checks if this entity object is still being updated and loaded. A non loaded entity would be someone who is in another dimension or out of the render distance for example.
overload 1:
player:isLoaded()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
PlayerAPI.getItem
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getItem(5).id == "minecraft:elytra" then
log("You're wearing an elytra")
end
Gets an ItemStack for the item in the given slot. For the player, slots are indexed with 1 as the main hand, 2 as the off hand, and 3,4,5,6 as the 4 armor slots from the boots to the helmet. If an invalid slot number is given, or if the entity has no item in that slot, this will return nil.
PlayerAPI.getNbt
Inherited from LivingEntityAPI
Gets a table containing the NBT of this entity. Please note that not all values in the entity's NBT may be synced, as some are handled only on server side.
overload 1:
player:getNbt()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a table | Table
|
PlayerAPI.getPos
Inherited from LivingEntityAPI
Gets the position of the entity in the world. If delta is passed in, then it will be used to linearly interpolate the position of the entity between the previous tick and the current tick. The default value of delta is 1.
PlayerAPI.getRot
Inherited from LivingEntityAPI
Gets the rotation of the entity in degrees. If delta is passed in, then it will be used to linearly interpolate the rotation of the entity between the previous tick and the current tick. The default value of delta is 1.
PlayerAPI.getLookDir
Inherited from LivingEntityAPI
Example by JimmyHelp:
models:setRot(player:getLookDir())
Returns a unit vector pointing in the direction that this entity is looking. See the blue line in the F3+B screen for an example.
overload 1:
player:getLookDir()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
PlayerAPI.isHamburger
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isHamburger() then
log("You're hamburger")
end
"Refused to elaborate."
overload 1:
player:isHamburger()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
PlayerAPI.getUUID
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getUUID() == "5003b2ce-7a8d-4c56-8b91-ec705985fe08" then
log("You're... me?")
end
Gets the UUID of the proxied entity.
overload 1:
player:getUUID()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
PlayerAPI.getVelocity
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getVelocity():length() > 0 then
log("You're moving in any direction")
end
Gets the current velocity of this entity in world coordinates, calculated as its position this tick minus its position last tick.
overload 1:
player:getVelocity()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
PlayerAPI.isUnderwater
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isUnderwater() then
log("You're underwater")
end
Returns true if this entity's eyes are touching water.
overload 1:
player:isUnderwater()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
PlayerAPI.getBoundingBox
Inherited from LivingEntityAPI
Example by JimmyHelp:
log(player:getBoundingBox())
Returns the size of this entity's bounding box as a Vector3. {x, y, z} are the width, height, and width. Minecraft entity hitboxes always have square bases.
overload 1:
player:getBoundingBox()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
PlayerAPI.getEyeHeight
Inherited from LivingEntityAPI
Example by JimmyHelp:
models:setPos(0,player:getEyeHeight())
Returns the current eye height of this entity.
overload 1:
player:getEyeHeight()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
PlayerAPI.hasAvatar
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:hasAvatar() then
log("You have an avatar")
end
Returns true if Figura has an avatar loaded for this entity.
overload 1:
player:hasAvatar()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
PlayerAPI.getVehicle
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getVehicle() and player:getVehicle():getType() == "minecraft:pig" then
log("You're riding a pig")
end
Returns a proxy for the entity that this player is currently riding. If the player isn't riding anything, returns nil.
overload 1:
player:getVehicle()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an EntityAPI | EntityAPI
|
PlayerAPI.isSprinting
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isSprinting() then
log("You're sprinting")
end
Returns true if this entity is currently sprinting.
overload 1:
player:isSprinting()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
PlayerAPI.getFireTicks
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getFireTicks() == 1 then
log("You're in a fire (returns -20 if not in a fire, the description is misleading)")
end
Returns the remaining number of ticks this entity will be on fire for.
overload 1:
player:getFireTicks()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
PlayerAPI.getMaxAir
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getMaxAir() == 300 then
log("You've got healthy lungs")
end
Gets the maximum amount of air this entity can have.
overload 1:
player:getMaxAir()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
PlayerAPI.getAir
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getAir() < 0 then
log("You're drowning")
end
Gets the current amount of air this entity has remaining.
overload 1:
player:getAir()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
PlayerAPI.getDimensionName
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getDimensionName() == "minecraft:overworld" then
log("You're in the Overworld")
end
Gets the Minecraft identifier of the dimension this entity is in.
overload 1:
player:getDimensionName()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
PlayerAPI.getFrozenTicks
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getFrozenTicks() == 140 then
log("You're being frozen solid")
end
Gets the number of ticks this entity has been freezing in powder snow for.
overload 1:
player:getFrozenTicks()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
PlayerAPI.isInLava
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isInLava() then
log("You're in lava")
end
Returns true if this entity is currently in lava.
overload 1:
player:isInLava()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
PlayerAPI.isWet
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isWet() then
log("You're touching water")
end
Returns true in any of three conditions: if the entity is in water, if the entity is in rain, or if the entity is in a bubble column. Otherwise, returns false.
overload 1:
player:isWet()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
PlayerAPI.getPose
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getPose() == "CROUCHING" then
log("You're crouching")
end
Returns the current pose of the player. This can be one of: "STANDING", "FALL_FLYING", "SLEEPING", "SWIMMING", "SPIN_ATTACK", "CROUCHING", "LONG_JUMPING", or "DYING".
overload 1:
player:getPose()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
PlayerAPI.isInWater
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isInWater() then
log("You're in water")
end
Returns true if this entity is currently in a water block, including waterlogging.
overload 1:
player:isInWater()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
PlayerAPI.isOnGround
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isOnGround() then
log("You're on the ground")
end
Returns whether or not this entity is currently on the ground.
overload 1:
player:isOnGround()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
PlayerAPI.isInRain
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isInRain() then
log("You're in rain")
end
Returns true if this entity is currently standing in rain.
overload 1:
player:isInRain()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
PlayerAPI.getEyeY
Inherited from LivingEntityAPI
Returns the Y level of this entity's eyes. Not to be confused with getEyeHeight, this function also takes the entity itself's Y position into account.
overload 1:
player:getEyeY()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
PlayerAPI.getTargetedBlock
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:getTargetedBlock(true,4.5).id == "minecraft:grass_block" then
log("You're looking at grass")
end
Returns a proxy for your currently targeted BlockState. This BlockState appears on the F3 screen. Maximum and Default distance is 20, Minimum is -20
overload 1:
player:getTargetedBlock()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a BlockState | BlockState
|
overload 2:
player:getTargetedBlock(ignoreLiquids)
| Method Property | Fluent Description | Representation |
|---|---|---|
| ignoreLiquids accepts | a Boolean | Boolean
|
| Return Value | a BlockState | BlockState
|
overload 3:
player:getTargetedBlock(ignoreLiquids, distance)
| Method Property | Fluent Description | Representation |
|---|---|---|
| ignoreLiquids accepts | a Boolean | Boolean
|
| distance accepts | a number | Number
|
| Return Value | a BlockState | BlockState
|
PlayerAPI.isOnFire
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isOnFire() then
log("You're on fire")
end
Returns true if this entity is currently on fire.
overload 1:
player:isOnFire()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
PlayerAPI.isSneaking
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isSneaking() then
log("You're sneaking")
end
Returns true if this entity is sneaking.
overload 1:
player:isSneaking()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
PlayerAPI.isGlowing
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isGlowing() then
log("You're glowing")
end
Returns true if this entity is currently glowing.
overload 1:
player:isGlowing()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
PlayerAPI.isSilent
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isSilent() then
log("You're silent")
end
Returns true if this entity is silent.
overload 1:
player:isSilent()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
PlayerAPI.getVariable
Inherited from LivingEntityAPI
PlayerAPI.isInvisible
Inherited from LivingEntityAPI
Example by JimmyHelp:
if player:isInvisible() then
log("You're invisible")
end
Returns true if this entity is invisible, for one reason or another.
overload 1:
player:isInvisible()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
renderer
The global instance of RendererAPI.
field signature:
renderer
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a RendererAPI | RendererAPI
|
RendererAPI.getCameraOffsetPivot
Gets the offset pivot for the camera.
overload 1:
renderer:getCameraOffsetPivot()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
RendererAPI.setShadowRadius
Sets the radius of your shadow. The default value is nil, which means to use the vanilla default of 0.5 for players. The maximum value is 12.
RendererAPI.setCameraPos
Sets the position offset for the camera. Nil values for position are assumed to be 0.
RendererAPI.getCameraOffsetRot
Gets the offset rotation for the camera.
overload 1:
renderer:getCameraOffsetRot()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
RendererAPI.getShadowRadius
Gets the radius of your shadow. The default value is nil, which means to use the vanilla default of 0.5 for players.
overload 1:
renderer:getShadowRadius()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
RendererAPI.isFirstPerson
Checks if your camera is in the first person view.
overload 1:
renderer:isFirstPerson()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
RendererAPI.isCameraBackwards
Checks if your camera is in the backwards third person view.
overload 1:
renderer:isCameraBackwards()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
RendererAPI.offsetCameraPivot
Sets the offset pivot for the camera. The pivot will also move the camera. Its values are relative to the world. Nil values for pivot are assumed to be 0. For relative rotation values, check out the non-offset pivot function.
RendererAPI.setCameraRot
Sets the absolute rotation of the camera. The position is not taken into account for roll. Nil values for rotation are assumed to be 0. For relative rotation values, check out the "offset" rot function.
RendererAPI.offsetCameraRot
Sets the offset rotation for the camera. Nil values for rotation are assumed to be 0. Angles are given in degrees. For absolute rotation values, check out the non-offset rot function.
RendererAPI.setCameraPivot
Sets the absolute pivot for the camera. The pivot will also move the camera. Its values are relative to the World. Nil values for pivot are assumed to be 0. For relative rotation values, check out the "offset" pivot function.
RendererAPI.getCameraPivot
Gets the absolute pivot for the camera.
overload 1:
renderer:getCameraPivot()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
RendererAPI.getCameraRot
Gets the absolute rotation of the camera.
overload 1:
renderer:getCameraRot()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
RendererAPI.renderFire
Whether or not you should visually have the fire effect while on fire. True by default.
field signature:
renderFire
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Boolean | Boolean
|
RendererAPI.renderVehicle
Whether or not your vehicle (boat, minecart, horse, whatever) will be rendered. True by default.
field signature:
renderVehicle
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Boolean | Boolean
|
RendererAPI.renderCrosshair
Toggles whether or not if your crosshair should render. True by default.
field signature:
renderCrosshair
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Boolean | Boolean
|
RendererAPI.forcePaperdoll
Toggles if the paperdoll should render regardless of the player doing an action. If the paperdoll is disabled, or set to always render, nothing will change. False by default.
field signature:
forcePaperdoll
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Boolean | Boolean
|
sounds
The global instance of SoundAPI.
field signature:
sounds
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a SoundAPI | SoundAPI
|
SoundAPI.playSound
Plays the specified sound at the specified position with the given volume and pitch multipliers. The sound id is either an identifier or the custom sound name. Volume in Minecraft refers to how far away people can hear the sound from, not the actual loudness of it. If you don't give values for volume and pitch, the default values are 1.
overload 4:
sounds:playSound(sound, posX, posY, posZ, volume, pitch, loop)
SoundAPI.stopSound
Stops the playing sounds from this avatar. If an id is specified, it only stops the sounds from that id.
SoundAPI.addSound
Registers a new custom sound for this avatar. The first argument is the sound id while the second argument is either a byte array of the sound data, or a base64 string representation of the same.
type
Figura overrides lua's type() function. When used on Figura types, returns the type's name as seen in the docs and in the figuraMetatables global. When called on a table that has a metatable with a __type key, returns the corresponding value.
field signature:
type
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Function | Function
|
user
An alias for player, just in case the user of your avatar isn't a player. (Foreshadowing?)
field signature:
user
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | an EntityAPI | EntityAPI
|
EntityAPI.getName
Gets the name of this entity, if it has a custom name. If it doesn't, returns a translated form of getType().
overload 1:
user:getName()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
EntityAPI.getType
Gets the Minecraft identifier of this entity. For instance, "minecraft:pig".
overload 1:
user:getType()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
EntityAPI.isLoaded
Checks if this entity object is still being updated and loaded. A non loaded entity would be someone who is in another dimension or out of the render distance for example.
overload 1:
user:isLoaded()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
EntityAPI.getItem
Gets an ItemStack for the item in the given slot. For the player, slots are indexed with 1 as the main hand, 2 as the off hand, and 3,4,5,6 as the 4 armor slots from the boots to the helmet. If an invalid slot number is given, or if the entity has no item in that slot, this will return nil.
EntityAPI.getNbt
Gets a table containing the NBT of this entity. Please note that not all values in the entity's NBT may be synced, as some are handled only on server side.
overload 1:
user:getNbt()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a table | Table
|
EntityAPI.getPos
Gets the position of the entity in the world. If delta is passed in, then it will be used to linearly interpolate the position of the entity between the previous tick and the current tick. The default value of delta is 1.
EntityAPI.getRot
Gets the rotation of the entity in degrees. If delta is passed in, then it will be used to linearly interpolate the rotation of the entity between the previous tick and the current tick. The default value of delta is 1.
EntityAPI.getLookDir
Returns a unit vector pointing in the direction that this entity is looking. See the blue line in the F3+B screen for an example.
overload 1:
user:getLookDir()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
EntityAPI.isHamburger
"Refused to elaborate."
overload 1:
user:isHamburger()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
EntityAPI.getUUID
Gets the UUID of the proxied entity.
overload 1:
user:getUUID()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
EntityAPI.getVelocity
Gets the current velocity of this entity in world coordinates, calculated as its position this tick minus its position last tick.
overload 1:
user:getVelocity()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
EntityAPI.isUnderwater
Returns true if this entity's eyes are touching water.
overload 1:
user:isUnderwater()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
EntityAPI.getBoundingBox
Returns the size of this entity's bounding box as a Vector3. {x, y, z} are the width, height, and width. Minecraft entity hitboxes always have square bases.
overload 1:
user:getBoundingBox()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
EntityAPI.getEyeHeight
Returns the current eye height of this entity.
overload 1:
user:getEyeHeight()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
EntityAPI.hasAvatar
Returns true if Figura has an avatar loaded for this entity.
overload 1:
user:hasAvatar()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
EntityAPI.isSprinting
Returns true if this entity is currently sprinting.
overload 1:
user:isSprinting()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
EntityAPI.getFireTicks
Returns the remaining number of ticks this entity will be on fire for.
overload 1:
user:getFireTicks()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
EntityAPI.getMaxAir
Gets the maximum amount of air this entity can have.
overload 1:
user:getMaxAir()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
EntityAPI.getAir
Gets the current amount of air this entity has remaining.
overload 1:
user:getAir()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
EntityAPI.getDimensionName
Gets the Minecraft identifier of the dimension this entity is in.
overload 1:
user:getDimensionName()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
EntityAPI.getFrozenTicks
Gets the number of ticks this entity has been freezing in powder snow for.
overload 1:
user:getFrozenTicks()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
EntityAPI.isInLava
Returns true if this entity is currently in lava.
overload 1:
user:isInLava()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
EntityAPI.isWet
Returns true in any of three conditions: if the entity is in water, if the entity is in rain, or if the entity is in a bubble column. Otherwise, returns false.
overload 1:
user:isWet()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
EntityAPI.getPose
Returns the current pose of the player. This can be one of: "STANDING", "FALL_FLYING", "SLEEPING", "SWIMMING", "SPIN_ATTACK", "CROUCHING", "LONG_JUMPING", or "DYING".
overload 1:
user:getPose()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
EntityAPI.isInWater
Returns true if this entity is currently in a water block, including waterlogging.
overload 1:
user:isInWater()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
EntityAPI.isOnGround
Returns whether or not this entity is currently on the ground.
overload 1:
user:isOnGround()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
EntityAPI.isInRain
Returns true if this entity is currently standing in rain.
overload 1:
user:isInRain()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
EntityAPI.getEyeY
Returns the Y level of this entity's eyes. Not to be confused with getEyeHeight, this function also takes the entity itself's Y position into account.
overload 1:
user:getEyeY()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
EntityAPI.getTargetedBlock
Returns a proxy for your currently targeted BlockState. This BlockState appears on the F3 screen. Maximum and Default distance is 20, Minimum is -20
overload 1:
user:getTargetedBlock()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a BlockState | BlockState
|
overload 2:
user:getTargetedBlock(ignoreLiquids)
| Method Property | Fluent Description | Representation |
|---|---|---|
| ignoreLiquids accepts | a Boolean | Boolean
|
| Return Value | a BlockState | BlockState
|
overload 3:
user:getTargetedBlock(ignoreLiquids, distance)
| Method Property | Fluent Description | Representation |
|---|---|---|
| ignoreLiquids accepts | a Boolean | Boolean
|
| distance accepts | a number | Number
|
| Return Value | a BlockState | BlockState
|
EntityAPI.isOnFire
Returns true if this entity is currently on fire.
overload 1:
user:isOnFire()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
EntityAPI.isSneaking
Returns true if this entity is sneaking.
overload 1:
user:isSneaking()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
EntityAPI.isGlowing
Returns true if this entity is currently glowing.
overload 1:
user:isGlowing()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
EntityAPI.isSilent
Returns true if this entity is silent.
overload 1:
user:isSilent()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
EntityAPI.isInvisible
Returns true if this entity is invisible, for one reason or another.
overload 1:
user:isInvisible()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
vanilla_model
The global instance of the VanillaModelAPI and its subtypes.
field signature:
vanilla_model
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelAPI | VanillaModelAPI
|
VanillaModelAPI.HEAD
The head of the player, not including the hat.
field signature:
HEAD
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.BODY
The body of the player, not including the outer layer.
field signature:
BODY
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.LEFT_ARM
The left arm of the player, not including the outer layer.
field signature:
LEFT_ARM
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.RIGHT_ARM
The right arm of the player, not including the outer layer.
field signature:
RIGHT_ARM
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.LEFT_LEG
The left leg of the player, not including the outer layer.
field signature:
LEFT_LEG
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.RIGHT_LEG
The right leg of the player, not including the outer layer.
field signature:
RIGHT_LEG
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.HAT
The outer layer of the player's head.
field signature:
HAT
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.JACKET
The outer layer of the player's body.
field signature:
JACKET
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.LEFT_SLEEVE
The outer layer of the player's left arm.
field signature:
LEFT_SLEEVE
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.RIGHT_SLEEVE
The outer layer of the player's right arm.
field signature:
RIGHT_SLEEVE
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.LEFT_PANTS
The outer layer of the player's left leg.
field signature:
LEFT_PANTS
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.RIGHT_PANTS
The outer layer of the player's right leg.
field signature:
RIGHT_PANTS
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.CAPE_MODEL
The vanilla cape model.
field signature:
CAPE_MODEL
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.FAKE_CAPE
A custom copy of the cape, as attempt of storing its transformations since vanilla cape math is... weird.
field signature:
FAKE_CAPE
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.HELMET_ITEM
The item on the armor head slot.
field signature:
HELMET_ITEM
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.HELMET_HEAD
The head of the helmet model.
field signature:
HELMET_HEAD
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.HELMET_HAT
The hat of the helmet model.
field signature:
HELMET_HAT
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.CHESTPLATE_BODY
The body of the chestplate model.
field signature:
CHESTPLATE_BODY
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.CHESTPLATE_LEFT_ARM
The left arm of the chestplate model.
field signature:
CHESTPLATE_LEFT_ARM
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.CHESTPLATE_RIGHT_ARM
The right arm of the chestplate model.
field signature:
CHESTPLATE_RIGHT_ARM
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.LEGGINGS_BODY
The body of the leggings model.
field signature:
LEGGINGS_BODY
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.LEGGINGS_LEFT_LEG
The left leg of the leggings model.
field signature:
LEGGINGS_LEFT_LEG
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.LEGGINGS_RIGHT_LEG
The right leg of the leggings model.
field signature:
LEGGINGS_RIGHT_LEG
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.BOOTS_LEFT_LEG
The left boot of the boots model.
field signature:
BOOTS_LEFT_LEG
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.BOOTS_RIGHT_LEG
The right boot of the boots model.
field signature:
BOOTS_RIGHT_LEG
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.LEFT_ELYTRA
The left wing of the elytra model.
field signature:
LEFT_ELYTRA
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.RIGHT_ELYTRA
The right wing of the elytra model.
field signature:
RIGHT_ELYTRA
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.LEFT_ITEM
The item in the player's left hand.
field signature:
LEFT_ITEM
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.RIGHT_ITEM
The item in the player's right hand.
field signature:
RIGHT_ITEM
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.LEFT_PARROT
The Parrot in the player's left shoulder.
field signature:
LEFT_PARROT
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.RIGHT_PARROT
The Parrot in the player's right shoulder.
field signature:
RIGHT_PARROT
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelPart | VanillaModelPart
|
VanillaModelAPI.ALL
Multi-part: The entirety of the vanilla model.
field signature:
ALL
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelGroup | VanillaModelGroup
|
VanillaModelAPI.PLAYER
Multi-part: Both the outer and inner layers of the player's skin, as well as the cape.
field signature:
PLAYER
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelGroup | VanillaModelGroup
|
VanillaModelAPI.OUTER_LAYER
Multi-part: The outer layer of the player.
field signature:
OUTER_LAYER
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelGroup | VanillaModelGroup
|
VanillaModelAPI.INNER_LAYER
Multi-part: The main body of the player, everything except the outer layer.
field signature:
INNER_LAYER
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelGroup | VanillaModelGroup
|
VanillaModelAPI.CAPE
Multi-part: The player's cape.
field signature:
CAPE
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelGroup | VanillaModelGroup
|
VanillaModelAPI.ARMOR
Multi-part: All armor on the model.
field signature:
ARMOR
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelGroup | VanillaModelGroup
|
VanillaModelAPI.HELMET
Multi-part: The helmet model.
field signature:
HELMET
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelGroup | VanillaModelGroup
|
VanillaModelAPI.CHESTPLATE
Multi-part: The chestplate model.
field signature:
CHESTPLATE
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelGroup | VanillaModelGroup
|
VanillaModelAPI.LEGGINGS
Multi-part: The leggings model.
field signature:
LEGGINGS
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelGroup | VanillaModelGroup
|
VanillaModelAPI.BOOTS
Multi-part: The boots model.
field signature:
BOOTS
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelGroup | VanillaModelGroup
|
VanillaModelAPI.ELYTRA
Multi-part: The elytra model.
field signature:
ELYTRA
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelGroup | VanillaModelGroup
|
VanillaModelAPI.HELD_ITEMS
Multi-part: Items in the player's hands.
field signature:
HELD_ITEMS
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelGroup | VanillaModelGroup
|
VanillaModelAPI.PARROTS
Multi-part: Parrots on the player's shoulders.
field signature:
PARROTS
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VanillaModelGroup | VanillaModelGroup
|
vectors
The global instance of the VectorsAPI and its subtypes.
field signature:
vectors
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a VectorsAPI | VectorsAPI
|
VectorsAPI.vec
Creates and returns a vector of the appropriate size to hold the arguments passed in. For example, if you call vec(3, 4, 0, 2), then the function will return a Vector4 containing those values. There is a global alias "vec" for this function, meaning the "vectors." can be omitted.
VectorsAPI.vec5
Creates and returns a Vector5 with the given values. Nil values become zero.
VectorsAPI.vec6
Creates and returns a Vector6 with the given values. Nil values become zero.
VectorsAPI.rotateAroundAxis
Rotates a vector relative to a rotation vector.
overload 3:
vectors.rotateAroundAxis(angle, vec, axisX, axisY, axisZ)
overload 4:
vectors.rotateAroundAxis(angle, x, y, z, axisX, axisY, axisZ)
VectorsAPI.worldToScreenSpace
Converts a position in the world into a position relative to the viewer's screen.
VectorsAPI.hexToRGB
Parses a hex string color into a RGB format vector. The hex "#" is optional, and it can have any length, however only the first 6 hex digits are evaluated, short hex (length 3) is also supported. For example, "#42" is the same as "420000", and "F0B" is the same as "FF00BB"
VectorsAPI.toCameraSpace
Converts a position in the world into a position relative to the viewer's camera.
VectorsAPI.rgbToInt
Converts the given color from RGB format to integer format.
VectorsAPI.hsvToRGB
Converts the given color from HSV format to RGB format.
VectorsAPI.rgbToHex
Converts the given color from RGB format to HEX format. The "#" is not included on the return hex.
VectorsAPI.rgbToHSV
Converts the given color from RGB format to HSV format.
VectorsAPI.rainbow
Gets an rgb vector with a shifting hue based on the given speed value and how much time the game is opened.
world
The global instance of the WorldAPI and its subtypes.
field signature:
world
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a WorldAPI | WorldAPI
|
WorldAPI.exists
Checks whether or not a world currently exists. This will almost always be true, but might be false on some occasions such as while travelling between dimensions.
overload 1:
world.exists()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
WorldAPI.getTime
Gets the current game time of the world. If delta is passed in, then it adds delta to the time. The default value of delta is zero.
WorldAPI.getTimeOfDay
Gets the current day time of the world. If delta is passed in, then it adds delta to the time. The default value of delta is zero.
WorldAPI.getBiome
Gets the Biome located at the given position.
WorldAPI.getBlockState
Gets the BlockState of the block at the given position.
overload 1:
world.getBlockState(pos)
| Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | Vector3
|
| Return Value | a BlockState | BlockState
|
overload 2:
world.getBlockState(x, y, z)
| Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a number | Number
|
| y accepts | a number | Number
|
| z accepts | a number | Number
|
| Return Value | a BlockState | BlockState
|
WorldAPI.getRedstonePower
Gets the redstone power level of the block at the given position.
WorldAPI.getLightLevel
Gets the overall light level of the block at the given position.
WorldAPI.isThundering
Gets whether or not there is currently thunder/lightning happening in the world.
overload 1:
world.isThundering()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
WorldAPI.isOpenSky
Gets whether or not the sky is open at the given position.
WorldAPI.getRainGradient
Gets the current rain gradient in the world, interpolated from the previous tick to the current one. The default value of delta is 1, which is the current tick.
WorldAPI.getSkyLightLevel
Gets the sky light level of the block at the given position.
WorldAPI.playerVars
Returns a table from all players in the world containing variables stored from their Avatar api's store() function. The players are indexed by their names.
overload 1:
world.playerVars()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a table | Table
|
WorldAPI.getBlockLightLevel
Gets the block light level of the block at the given position.
WorldAPI.newBlock
Parses and create a new BlockState from the given string. A world position can be optionally given for the blockstate functions that relies on its position.
overload 1:
world.newBlock(block)
| Method Property | Fluent Description | Representation |
|---|---|---|
| block accepts | a string | String
|
| Return Value | a BlockState | BlockState
|
overload 2:
world.newBlock(block, pos)
| Method Property | Fluent Description | Representation |
|---|---|---|
| block accepts | a string | String
|
| pos accepts | a Vector3 | Vector3
|
| Return Value | a BlockState | BlockState
|
overload 3:
world.newBlock(block, x, y, z)
| Method Property | Fluent Description | Representation |
|---|---|---|
| block accepts | a string | String
|
| x accepts | a number | Number
|
| y accepts | a number | Number
|
| z accepts | a number | Number
|
| Return Value | a BlockState | BlockState
|
WorldAPI.getMoonPhase
Gets the current moon phase of the world, stored as an integer.
overload 1:
world.getMoonPhase()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
WorldAPI.newItem
Parses and create a new ItemStack from the given string. A count and damage can be given, to be applied on this itemstack.
WorldAPI.getStrongRedstonePower
Gets the direct redstone power level of the block at the given position.
Action
An action in the Figura Action Wheel. An abstract superclass of ClickAction, ToggleAction, and ScrollAction.
Action.color
Sets the color of the Action. Returns the Action for function chaining.
Action.item
Sets the item of the Action. Returns the Action for function chaining.
Action.title
Sets the title of the Action. Returns the Action for function chaining.
Action.getTitle
Gets this Action title.
overload 1:
Action:getTitle()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
Action.getHoverColor
Gets this Action hover color.
overload 1:
Action:getHoverColor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
Action.hoverColor
Sets the color of the Action when it is being hovered. Returns the Action for function chaining.
Action.hoverItem
Sets the item of the Action when it is being hovered. Returns the Action for function chaining.
Action.getColor
Gets this Action color.
overload 1:
Action:getColor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
Animation
A blockbench animation.
Animation.getLength
Gets the animation's length.
overload 1:
Animation:getLength()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Animation.getPriority
Gets the animation's priority.
overload 1:
Animation:getPriority()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
Animation.stop
Stop the animation.
Animation.getOffset
Gets the animation's offset time.
overload 1:
Animation:getOffset()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Animation.getTime
Get the animation's playback current time.
overload 1:
Animation:getTime()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Animation.getPlayState
Get the animation's playback state.
overload 1:
Animation:getPlayState()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
Animation.getBlend
Gets the animation's keyframe blend factor.
overload 1:
Animation:getBlend()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Animation.getStartDelay
Gets the animation's start delay.
overload 1:
Animation:getStartDelay()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Animation.getLoopDelay
Gets the animation's loop delay.
overload 1:
Animation:getLoopDelay()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Animation.restart
Restarts the animation. Plays the animation if it was stopped. This behaviour can also be reproduced by stopping then playing the animation
overload 1:
Animation:restart()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | nil | nil
|
Animation.getSpeed
Gets the animation's speed.
overload 1:
Animation:getSpeed()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Animation.getLoop
Gets the animation's loop mode.
overload 1:
Animation:getLoop()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
Animation.getOverride
Gets the animation's override status.
overload 1:
Animation:getOverride()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
Animation.pause
Pause the animation's playback.
overload 1:
Animation:pause()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | nil | nil
|
Animation.play
Example by JimmyHelp:
animations.bbmodelName.animationName:play()
Initializes the animation. Resume the animation if it was paused.
Animation.name
This animation's name.
Biome
A proxy for a Minecraft biome. Instances are obtained through the WorldAPI. This proxy also contains a saved position for the Biome.
Biome.getName
Returns the name of the biome, according to the registry.
overload 1:
Biome:getName()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
Biome.getPos
Returns the saved position for this Biome's proxy. The saved position is used in Biome functions that require a position.
overload 1:
Biome:getPos()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
Biome.setPos
Sets the saved position for this Biome's proxy. The saved position is used in Biome functions that require a position.
Biome.getPrecipitation
Gets the rain type of this biome. The type can be "NONE", "RAIN" or "SNOW".
overload 1:
Biome:getPrecipitation()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
Biome.getGrassColor
Gets this biome's grass color as a RGB vector.
overload 1:
Biome:getGrassColor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
Biome.getFoliageColor
Gets this biome's foliage color as a RGB vector.
overload 1:
Biome:getFoliageColor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
Biome.getTemperature
Gets the temperature of this biome.
overload 1:
Biome:getTemperature()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Biome.getSkyColor
Gets this biome's sky color as a RGB vector.
overload 1:
Biome:getSkyColor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
Biome.isCold
Checks if this biome is cold.
overload 1:
Biome:isCold()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
Biome.getDownfall
Gets this biome's humidity.
overload 1:
Biome:getDownfall()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Biome.getWaterColor
Gets this biome's water color as a RGB vector.
overload 1:
Biome:getWaterColor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
Biome.isHot
Checks if this biome is hot.
overload 1:
Biome:isHot()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
Biome.getFogColor
Gets this biome's fog color as a RGB vector.
overload 1:
Biome:getFogColor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
Biome.getWaterFogColor
Gets this biome's water fog color as a RGB vector.
overload 1:
Biome:getWaterFogColor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
BlockState
A proxy for a block state from Minecraft. Instances are obtained through the WorldAPI. This proxy also contains a saved position for the BlockState.
BlockState.isOpaque
Gets whether or not this BlockState is opaque.
overload 1:
BlockState:isOpaque()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
BlockState.hasCollision
Returns true if this block has collision.
overload 1:
BlockState:hasCollision()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
BlockState.getMaterial
Gets the name of the material this block is made of.
overload 1:
BlockState:getMaterial()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
BlockState.getHardness
Gets the hardness of the BlockState.
overload 1:
BlockState:getHardness()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
BlockState.getLuminance
Gets the emission light level of this BlockState.
overload 1:
BlockState:getLuminance()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
BlockState.getPos
Returns the saved position for this BlockState proxy. The saved position is used in BlockState functions that require a position.
overload 1:
BlockState:getPos()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
BlockState.setPos
Sets the saved position for this BlockState proxy. The saved position is used in BlockState functions that require a position.
BlockState.isTranslucent
Gets whether or not the BlockState would propagate sky light downwards.
overload 1:
BlockState:isTranslucent()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
BlockState.emitsRedstonePower
Gets whether or not this BlockState emits redstone power.
overload 1:
BlockState:emitsRedstonePower()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
BlockState.getFriction
Gets the friction of this BlockState. (Slime blocks and ice in vanilla)
overload 1:
BlockState:getFriction()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
BlockState.isSolidBlock
Gets whether or not the BlockState is considered a "solid" block by Minecraft.
overload 1:
BlockState:isSolidBlock()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
BlockState.getMapColor
Gets the map color of this BlockState, as a Vector3 with R,G,B ranging 0 to 1.
overload 1:
BlockState:getMapColor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
BlockState.hasBlockEntity
Gets whether or not this BlockState has an associated block entity.
overload 1:
BlockState:hasBlockEntity()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
BlockState.getOpacity
Gets the opacity of the BlockState, in terms of how much it affects light levels.
overload 1:
BlockState:getOpacity()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
BlockState.getBlastResistance
Gets the blast resistance of this BlockState.
overload 1:
BlockState:getBlastResistance()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
BlockState.isFullCube
Gets whether or not the BlockState has a full cube as its collision hitbox.
overload 1:
BlockState:isFullCube()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
BlockState.getCollisionShape
Returns a table representing the bounding boxes of the collision shape. The table a list of Vector6, where the first 3 coordinates are one corner of the box and the last 3 are the other corner.
overload 1:
BlockState:getCollisionShape()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a table | Table
|
BlockState.toStateString
Converts this BlockState into a string, like you'd see in a Minecraft command.
overload 1:
BlockState:toStateString()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
BlockState.getOutlineShape
Returns a table representing the bounding boxes of the outline shape. The table a list of Vector6, where the first 3 coordinates are one corner of the box and the last 3 are the other corner.
overload 1:
BlockState:getOutlineShape()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a table | Table
|
BlockState.getEntityData
Returns the nbt of the Block Entity associated with this BlockState, at its position, as a table. Since the mod is only on client side, this NBT might not actually contain the real nbt, which is stored server-side.
overload 1:
BlockState:getEntityData()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a table | Table
|
BlockState.getFluidTags
Returns a table containing all the fluid tags of this block, as strings.
overload 1:
BlockState:getFluidTags()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a table | Table
|
BlockState.getSounds
Gets the names of all the sounds which can play from this BlockState, as well as their pitch and volume. Stored in a table.
overload 1:
BlockState:getSounds()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a table | Table
|
BlockState.getTags
Returns a table containing all the tags of this block, as strings.
overload 1:
BlockState:getTags()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a table | Table
|
BlockState.hasEmissiveLighting
Gets whether or not the BlockState uses emissive lighting.
overload 1:
BlockState:hasEmissiveLighting()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
BlockState.getComparatorOutput
Gets the amount of signal strength a comparator would get from this BlockState.
overload 1:
BlockState:getComparatorOutput()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
BlockState.getVelocityMultiplier
Gets the velocity multiplier of this BlockState. (Only Soul sand, honey blocks in vanilla)
overload 1:
BlockState:getVelocityMultiplier()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
BlockState.getJumpVelocityMultiplier
Gets the jump velocity multiplier of this BlockState. (Literally just honey blocks in vanilla)
overload 1:
BlockState:getJumpVelocityMultiplier()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
BlockState.id
The identifier of the block this BlockState comes from.
BlockState.properties
A table containing the properties of this BlockState. If this BlockState has no properties, it is nil.
field signature:
properties
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a table | Table
|
BlockTask.block
Sets the Block for this task render.
overload 1:
BlockTask:block(block)
| Method Property | Fluent Description | Representation |
|---|---|---|
| block accepts | a string | String
|
| Return Value | a RenderTask | RenderTask
|
overload 2:
BlockTask:block(block)
| Method Property | Fluent Description | Representation |
|---|---|---|
| block accepts | a BlockState | BlockState
|
| Return Value | a RenderTask | RenderTask
|
BlockTask.scale
Inherited from RenderTask
The scale of the task, relative with its attached part.
overload 1:
BlockTask:scale(scale)
| Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | a Vector3 | Vector3
|
| Return Value | a RenderTask | RenderTask
|
overload 2:
BlockTask:scale(x, y, z)
| Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a number | Number
|
| y accepts | a number | Number
|
| z accepts | a number | Number
|
| Return Value | a RenderTask | RenderTask
|
BlockTask.enabled
Inherited from RenderTask
Whether or not this task should be rendered.
overload 1:
BlockTask:enabled(bool)
| Method Property | Fluent Description | Representation |
|---|---|---|
| bool accepts | a Boolean | Boolean
|
| Return Value | a RenderTask | RenderTask
|
BlockTask.pos
Inherited from RenderTask
The position of the task, relative with its attached part. Uses model coordinates.
overload 1:
BlockTask:pos(pos)
| Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | Vector3
|
| Return Value | a RenderTask | RenderTask
|
overload 2:
BlockTask:pos(x, y, z)
| Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a number | Number
|
| y accepts | a number | Number
|
| z accepts | a number | Number
|
| Return Value | a RenderTask | RenderTask
|
BlockTask.isEnabled
Inherited from RenderTask
Checks if this task is enabled.
overload 1:
BlockTask:isEnabled()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
BlockTask.emissive
Inherited from RenderTask
Whether or not this task should be rendered at full bright.
overload 1:
BlockTask:emissive(bool)
| Method Property | Fluent Description | Representation |
|---|---|---|
| bool accepts | a Boolean | Boolean
|
| Return Value | a RenderTask | RenderTask
|
BlockTask.isEmissive
Inherited from RenderTask
Checks if this task is emissive.
overload 1:
BlockTask:isEmissive()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
BlockTask.getScale
Inherited from RenderTask
Gets this task scale.
overload 1:
BlockTask:getScale()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
BlockTask.getPos
Inherited from RenderTask
Gets this task position.
overload 1:
BlockTask:getPos()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
BlockTask.getRot
Inherited from RenderTask
Gets this task rotation.
overload 1:
BlockTask:getRot()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
BlockTask.rot
Inherited from RenderTask
The rotation of the task, relative with its attached part.
overload 1:
BlockTask:rot(rot)
| Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | a Vector3 | Vector3
|
| Return Value | a RenderTask | RenderTask
|
overload 2:
BlockTask:rot(x, y, z)
| Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a number | Number
|
| y accepts | a number | Number
|
| z accepts | a number | Number
|
| Return Value | a RenderTask | RenderTask
|
ClickAction.onLeftClick
Example by applejuice:
local myAction = myPage:newAction()
myAction:onLeftClick(function()
log("Heheh I got Left Clicked!")
end)
ClickAction.onRightClick
Example by applejuice:
local myAction = myPage:newAction()
myAction:onRightClick(function()
log("Heheh I got Right Clicked!")
end)
ClickAction.color
Inherited from Action
Sets the color of the Action. Returns the Action for function chaining.
ClickAction.item
Inherited from Action
Sets the item of the Action. Returns the Action for function chaining.
ClickAction.title
Inherited from Action
Sets the title of the Action. Returns the Action for function chaining.
ClickAction.getTitle
Inherited from Action
Gets this Action title.
overload 1:
ClickAction:getTitle()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ClickAction.getHoverColor
Inherited from Action
Gets this Action hover color.
overload 1:
ClickAction:getHoverColor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
ClickAction.hoverColor
Inherited from Action
Sets the color of the Action when it is being hovered. Returns the Action for function chaining.
ClickAction.hoverItem
Inherited from Action
Sets the item of the Action when it is being hovered. Returns the Action for function chaining.
ClickAction.getColor
Inherited from Action
Gets this Action color.
overload 1:
ClickAction:getColor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
ClickAction.leftClick
Function that is executed when the left mouse button is clicked.
field signature:
leftClick
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Function | Function
|
ClickAction.rightClick
Function that is executed when the right mouse button is clicked.
field signature:
rightClick
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Function | Function
|
EntityNameplateCustomization
subclasses NameplateCustomization
A nameplate customization that is specialized for entities.
EntityNameplateCustomization.setScale
Sets the scale factor of the nameplate.
EntityNameplateCustomization.getScale
Gets scale factor of the nameplate.
overload 1:
EntityNameplateCustomization:getScale()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
EntityNameplateCustomization.getPos
Gets the position offset of the nameplate, in world coordinates.
overload 1:
EntityNameplateCustomization:getPos()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
EntityNameplateCustomization.setPos
Sets the position offset of the nameplate, in world coordinates.
EntityNameplateCustomization.getText
Inherited from NameplateCustomization
The text to use in this nameplate.
overload 1:
EntityNameplateCustomization:getText()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
EntityNameplateCustomization.setText
Inherited from NameplateCustomization
EntityNameplateCustomization.visible
Whether or not should the nameplate be rendered.
field signature:
visible
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Boolean | Boolean
|
EntityNameplateCustomization.background
Whether or not should the nameplate have a background.
field signature:
background
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Boolean | Boolean
|
EntityNameplateCustomization.shadow
Whether or not should the nameplate have shadow. Incompatible with "outline".
field signature:
shadow
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Boolean | Boolean
|
EntityNameplateCustomization.outline
Whether or not should the nameplate have outline. Incompatible with "shadow".
field signature:
outline
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Boolean | Boolean
|
Event
A hook for a certain event in Minecraft. You may register functions to one, and those functions will be called when the event occurs.
Event.clear
Clears the given event of all its functions.
Event.register
Registers the given function to the given event. When the event occurs, the function will be run. Functions are run in the order they were registered. The optional name parameter is used when you wish to later remove a function from the event.
ItemStack
A proxy for an item stack from Minecraft.
ItemStack.getName
Gets the name of the item.
overload 1:
ItemStack:getName()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ItemStack.getCount
Gets the number of items in this stack.
overload 1:
ItemStack:getCount()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
ItemStack.getDamage
Gets the damage value of the item in this stack. Works on things like tools, or other things with a durability bar.
overload 1:
ItemStack:getDamage()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
ItemStack.getCooldown
Gets the remaining cooldown on this item, in ticks.
overload 1:
ItemStack:getCooldown()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
ItemStack.getTags
Gets all the tags of this item as strings in a table.
overload 1:
ItemStack:getTags()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a table | Table
|
ItemStack.hasGlint
Returns true if this item glows with enchantment glint.
overload 1:
ItemStack:hasGlint()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
ItemStack.getRepairCost
Gets the repair cost modifier, in an anvil, for this item stack.
overload 1:
ItemStack:getRepairCost()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
ItemStack.getUseAction
Returns the name of the animation that plays when using this item.
overload 1:
ItemStack:getUseAction()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ItemStack.isEnchantable
Returns true if this item stack can be put in an enchanting table.
overload 1:
ItemStack:isEnchantable()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
ItemStack.getUseDuration
Gets the number of ticks needed to "use" this item. Currently only has a use for food items. Always 32 for food items except kelp, which is 16.
overload 1:
ItemStack:getUseDuration()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
ItemStack.isBlockItem
Returns true if this item represents a block.
overload 1:
ItemStack:isBlockItem()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
ItemStack.isDamageable
Returns true if this item stack has durability.
overload 1:
ItemStack:isDamageable()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
ItemStack.toStackString
Converts this ItemStack to a string, like you'd see in a command.
overload 1:
ItemStack:toStackString()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ItemStack.isStackable
Returns true if the item is stackable.
overload 1:
ItemStack:isStackable()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
ItemStack.isFood
Returns true if this item is edible.
overload 1:
ItemStack:isFood()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
ItemStack.getMaxDamage
Gets the maximum durability of this item stack.
overload 1:
ItemStack:getMaxDamage()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
ItemStack.getMaxCount
Gets the maximum stack size of this item.
overload 1:
ItemStack:getMaxCount()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
ItemStack.getRarity
Gets the rarity of this item stack. COMMON = white, UNCOMMON = yellow, RARE = aqua, EPIC = light purple.
overload 1:
ItemStack:getRarity()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ItemStack.id
Contains the id of the item this ItemStack refers to.
ItemStack.tag
A table containing the NBT tag of this ItemStack. If this ItemStack has nothing in its tag, it is nil.
ItemTask.item
Sets the Item for this task render.
overload 1:
ItemTask:item(item)
| Method Property | Fluent Description | Representation |
|---|---|---|
| item accepts | a string | String
|
| Return Value | a RenderTask | RenderTask
|
overload 2:
ItemTask:item(item)
| Method Property | Fluent Description | Representation |
|---|---|---|
| item accepts | an ItemStack | ItemStack
|
| Return Value | a RenderTask | RenderTask
|
ItemTask.renderType
Sets the type of item rendering to use for this task.
overload 1:
ItemTask:renderType(renderType)
| Method Property | Fluent Description | Representation |
|---|---|---|
| renderType accepts | a string | String
|
| Return Value | a RenderTask | RenderTask
|
ItemTask.getRenderType
Gets this task item rendering type.
overload 1:
ItemTask:getRenderType()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ItemTask.scale
Inherited from RenderTask
The scale of the task, relative with its attached part.
overload 1:
ItemTask:scale(scale)
| Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | a Vector3 | Vector3
|
| Return Value | a RenderTask | RenderTask
|
overload 2:
ItemTask:scale(x, y, z)
| Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a number | Number
|
| y accepts | a number | Number
|
| z accepts | a number | Number
|
| Return Value | a RenderTask | RenderTask
|
ItemTask.enabled
Inherited from RenderTask
Whether or not this task should be rendered.
overload 1:
ItemTask:enabled(bool)
| Method Property | Fluent Description | Representation |
|---|---|---|
| bool accepts | a Boolean | Boolean
|
| Return Value | a RenderTask | RenderTask
|
ItemTask.pos
Inherited from RenderTask
The position of the task, relative with its attached part. Uses model coordinates.
overload 1:
ItemTask:pos(pos)
| Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | Vector3
|
| Return Value | a RenderTask | RenderTask
|
overload 2:
ItemTask:pos(x, y, z)
| Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a number | Number
|
| y accepts | a number | Number
|
| z accepts | a number | Number
|
| Return Value | a RenderTask | RenderTask
|
ItemTask.isEnabled
Inherited from RenderTask
Checks if this task is enabled.
overload 1:
ItemTask:isEnabled()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
ItemTask.emissive
Inherited from RenderTask
Whether or not this task should be rendered at full bright.
overload 1:
ItemTask:emissive(bool)
| Method Property | Fluent Description | Representation |
|---|---|---|
| bool accepts | a Boolean | Boolean
|
| Return Value | a RenderTask | RenderTask
|
ItemTask.isEmissive
Inherited from RenderTask
Checks if this task is emissive.
overload 1:
ItemTask:isEmissive()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
ItemTask.getScale
Inherited from RenderTask
Gets this task scale.
overload 1:
ItemTask:getScale()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
ItemTask.getPos
Inherited from RenderTask
Gets this task position.
overload 1:
ItemTask:getPos()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
ItemTask.getRot
Inherited from RenderTask
Gets this task rotation.
overload 1:
ItemTask:getRot()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
ItemTask.rot
Inherited from RenderTask
The rotation of the task, relative with its attached part.
overload 1:
ItemTask:rot(rot)
| Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | a Vector3 | Vector3
|
| Return Value | a RenderTask | RenderTask
|
overload 2:
ItemTask:rot(x, y, z)
| Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a number | Number
|
| y accepts | a number | Number
|
| z accepts | a number | Number
|
| Return Value | a RenderTask | RenderTask
|
Keybind
Represents a key binding for your script. Instances are obtained using the KeybindAPI's create() function.
Keybind.getName
Gets the name of the keybind, which you set when you created the keybind.
overload 1:
Keybind:getName()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
Keybind.getKey
Gets the current key for this keybind.
overload 1:
Keybind:getKey()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
Keybind.isDefault
Checks whether this key is currently set to its default state (not been changed using the keybind menu)
overload 1:
Keybind:isDefault()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
Keybind.getKeyName
Gets the name of the current key for this keybind.
overload 1:
Keybind:getKeyName()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
Keybind.isPressed
Gets whether this keybind is currently pressed down.
overload 1:
Keybind:isPressed()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
Keybind.onPress
A function that runs when the key is pressed down.
field signature:
onPress
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Function | Function
|
Keybind.onRelease
A function that runs when the key is released.
field signature:
onRelease
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Function | Function
|
Keybind.enabled
Toggles if this keybind should be processed or not.
field signature:
enabled
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Boolean | Boolean
|
Keybind.gui
Whenever or not this keybind should run when a GUI is open.
Keybind.override
Toggles if this keybind should stop vanilla keys from running.
field signature:
override
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Boolean | Boolean
|
LivingEntityAPI.getBodyYaw
Gets the yaw of this entity's body in degrees. If delta is passed in, then it will be used to linearly interpolate the rotation of the body between the previous tick and the current tick. The default value of delta is 1.
LivingEntityAPI.getHeldItem
Returns an ItemStack representing the item in this entity's main hand. If true is passed in for "offhand", then it will instead look at the item in the entity's offhand. If the entity isn't holding an item in that hand, returns nil.
LivingEntityAPI.getActiveItem
Returns an ItemStack representing the item the entity is currently using. If they're not using any item, returns nil.
overload 1:
LivingEntityAPI:getActiveItem()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an ItemStack | ItemStack
|
LivingEntityAPI.getDeathTime
Returns the number of ticks this entity has been dead for.
overload 1:
LivingEntityAPI:getDeathTime()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
LivingEntityAPI.isClimbing
Returns true if the entity is currently using a climbable block, like a ladder or vine.
overload 1:
LivingEntityAPI:isClimbing()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
LivingEntityAPI.isUsingItem
Returns true if the entity is currently using an item.
overload 1:
LivingEntityAPI:isUsingItem()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
LivingEntityAPI.getStingerCount
Returns the number of bee stingers sticking out of this entity.
overload 1:
LivingEntityAPI:getStingerCount()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
LivingEntityAPI.isLeftHanded
Returns true if the entity's main hand is its left.
overload 1:
LivingEntityAPI:isLeftHanded()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
LivingEntityAPI.getArmor
Returns the amount of armor points this entity has.
overload 1:
LivingEntityAPI:getArmor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
LivingEntityAPI.getHealth
Returns the amount of health this entity has remaining.
overload 1:
LivingEntityAPI:getHealth()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
LivingEntityAPI.getStatusEffects
Returns, as a table, all of the status effects this entity has on it. The table contains sub-tables, each of which contains the name, amplifier, duration, and particle visibility of an effect this entity has.
overload 1:
LivingEntityAPI:getStatusEffects()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a table | Table
|
LivingEntityAPI.getArrowCount
Returns the number of arrows sticking out of this entity.
overload 1:
LivingEntityAPI:getArrowCount()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
LivingEntityAPI.getActiveHand
Returns "OFF_HAND" or "MAIN_HAND", depending on which hand this entity uses an item with.
overload 1:
LivingEntityAPI:getActiveHand()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
LivingEntityAPI.getMaxHealth
Returns the maximum amount of health this entity can have.
overload 1:
LivingEntityAPI:getMaxHealth()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
LivingEntityAPI.getName
Inherited from EntityAPI
Gets the name of this entity, if it has a custom name. If it doesn't, returns a translated form of getType().
overload 1:
LivingEntityAPI:getName()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
LivingEntityAPI.getType
Inherited from EntityAPI
Gets the Minecraft identifier of this entity. For instance, "minecraft:pig".
overload 1:
LivingEntityAPI:getType()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
LivingEntityAPI.isLoaded
Inherited from EntityAPI
Checks if this entity object is still being updated and loaded. A non loaded entity would be someone who is in another dimension or out of the render distance for example.
overload 1:
LivingEntityAPI:isLoaded()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
LivingEntityAPI.getItem
Inherited from EntityAPI
Gets an ItemStack for the item in the given slot. For the player, slots are indexed with 1 as the main hand, 2 as the off hand, and 3,4,5,6 as the 4 armor slots from the boots to the helmet. If an invalid slot number is given, or if the entity has no item in that slot, this will return nil.
LivingEntityAPI.getNbt
Inherited from EntityAPI
Gets a table containing the NBT of this entity. Please note that not all values in the entity's NBT may be synced, as some are handled only on server side.
overload 1:
LivingEntityAPI:getNbt()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a table | Table
|
LivingEntityAPI.getPos
Inherited from EntityAPI
Gets the position of the entity in the world. If delta is passed in, then it will be used to linearly interpolate the position of the entity between the previous tick and the current tick. The default value of delta is 1.
LivingEntityAPI.getRot
Inherited from EntityAPI
Gets the rotation of the entity in degrees. If delta is passed in, then it will be used to linearly interpolate the rotation of the entity between the previous tick and the current tick. The default value of delta is 1.
LivingEntityAPI.getLookDir
Inherited from EntityAPI
Returns a unit vector pointing in the direction that this entity is looking. See the blue line in the F3+B screen for an example.
overload 1:
LivingEntityAPI:getLookDir()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
LivingEntityAPI.isHamburger
Inherited from EntityAPI
"Refused to elaborate."
overload 1:
LivingEntityAPI:isHamburger()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
LivingEntityAPI.getUUID
Inherited from EntityAPI
Gets the UUID of the proxied entity.
overload 1:
LivingEntityAPI:getUUID()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
LivingEntityAPI.getVelocity
Inherited from EntityAPI
Gets the current velocity of this entity in world coordinates, calculated as its position this tick minus its position last tick.
overload 1:
LivingEntityAPI:getVelocity()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
LivingEntityAPI.isUnderwater
Inherited from EntityAPI
Returns true if this entity's eyes are touching water.
overload 1:
LivingEntityAPI:isUnderwater()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
LivingEntityAPI.getBoundingBox
Inherited from EntityAPI
Returns the size of this entity's bounding box as a Vector3. {x, y, z} are the width, height, and width. Minecraft entity hitboxes always have square bases.
overload 1:
LivingEntityAPI:getBoundingBox()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
LivingEntityAPI.getEyeHeight
Inherited from EntityAPI
Returns the current eye height of this entity.
overload 1:
LivingEntityAPI:getEyeHeight()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
LivingEntityAPI.hasAvatar
Inherited from EntityAPI
Returns true if Figura has an avatar loaded for this entity.
overload 1:
LivingEntityAPI:hasAvatar()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
LivingEntityAPI.getVehicle
Inherited from EntityAPI
Returns a proxy for the entity that this player is currently riding. If the player isn't riding anything, returns nil.
overload 1:
LivingEntityAPI:getVehicle()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an EntityAPI | EntityAPI
|
LivingEntityAPI.isSprinting
Inherited from EntityAPI
Returns true if this entity is currently sprinting.
overload 1:
LivingEntityAPI:isSprinting()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
LivingEntityAPI.getFireTicks
Inherited from EntityAPI
Returns the remaining number of ticks this entity will be on fire for.
overload 1:
LivingEntityAPI:getFireTicks()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
LivingEntityAPI.getMaxAir
Inherited from EntityAPI
Gets the maximum amount of air this entity can have.
overload 1:
LivingEntityAPI:getMaxAir()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
LivingEntityAPI.getAir
Inherited from EntityAPI
Gets the current amount of air this entity has remaining.
overload 1:
LivingEntityAPI:getAir()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
LivingEntityAPI.getDimensionName
Inherited from EntityAPI
Gets the Minecraft identifier of the dimension this entity is in.
overload 1:
LivingEntityAPI:getDimensionName()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
LivingEntityAPI.getFrozenTicks
Inherited from EntityAPI
Gets the number of ticks this entity has been freezing in powder snow for.
overload 1:
LivingEntityAPI:getFrozenTicks()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | an Integer | Integer
|
LivingEntityAPI.isInLava
Inherited from EntityAPI
Returns true if this entity is currently in lava.
overload 1:
LivingEntityAPI:isInLava()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
LivingEntityAPI.isWet
Inherited from EntityAPI
Returns true in any of three conditions: if the entity is in water, if the entity is in rain, or if the entity is in a bubble column. Otherwise, returns false.
overload 1:
LivingEntityAPI:isWet()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
LivingEntityAPI.getPose
Inherited from EntityAPI
Returns the current pose of the player. This can be one of: "STANDING", "FALL_FLYING", "SLEEPING", "SWIMMING", "SPIN_ATTACK", "CROUCHING", "LONG_JUMPING", or "DYING".
overload 1:
LivingEntityAPI:getPose()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
LivingEntityAPI.isInWater
Inherited from EntityAPI
Returns true if this entity is currently in a water block, including waterlogging.
overload 1:
LivingEntityAPI:isInWater()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
LivingEntityAPI.isOnGround
Inherited from EntityAPI
Returns whether or not this entity is currently on the ground.
overload 1:
LivingEntityAPI:isOnGround()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
LivingEntityAPI.isInRain
Inherited from EntityAPI
Returns true if this entity is currently standing in rain.
overload 1:
LivingEntityAPI:isInRain()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
LivingEntityAPI.getEyeY
Inherited from EntityAPI
Returns the Y level of this entity's eyes. Not to be confused with getEyeHeight, this function also takes the entity itself's Y position into account.
overload 1:
LivingEntityAPI:getEyeY()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
LivingEntityAPI.getTargetedBlock
Inherited from EntityAPI
Returns a proxy for your currently targeted BlockState. This BlockState appears on the F3 screen. Maximum and Default distance is 20, Minimum is -20
overload 1:
LivingEntityAPI:getTargetedBlock()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a BlockState | BlockState
|
overload 2:
LivingEntityAPI:getTargetedBlock(ignoreLiquids)
| Method Property | Fluent Description | Representation |
|---|---|---|
| ignoreLiquids accepts | a Boolean | Boolean
|
| Return Value | a BlockState | BlockState
|
overload 3:
LivingEntityAPI:getTargetedBlock(ignoreLiquids, distance)
| Method Property | Fluent Description | Representation |
|---|---|---|
| ignoreLiquids accepts | a Boolean | Boolean
|
| distance accepts | a number | Number
|
| Return Value | a BlockState | BlockState
|
LivingEntityAPI.isOnFire
Inherited from EntityAPI
Returns true if this entity is currently on fire.
overload 1:
LivingEntityAPI:isOnFire()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
LivingEntityAPI.isSneaking
Inherited from EntityAPI
Returns true if this entity is sneaking.
overload 1:
LivingEntityAPI:isSneaking()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
LivingEntityAPI.isGlowing
Inherited from EntityAPI
Returns true if this entity is currently glowing.
overload 1:
LivingEntityAPI:isGlowing()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
LivingEntityAPI.isSilent
Inherited from EntityAPI
Returns true if this entity is silent.
overload 1:
LivingEntityAPI:isSilent()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
LivingEntityAPI.getVariable
Inherited from EntityAPI
LivingEntityAPI.isInvisible
Inherited from EntityAPI
Returns true if this entity is invisible, for one reason or another.
overload 1:
LivingEntityAPI:isInvisible()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
Matrix2
A matrix with 2 rows and 2 columns.
| Meta name | Allowed other parameters | Meta execution method |
|---|---|---|
__le
|
|
x <= y
|
__eq
|
|
x == y
|
__mul
|
|
x * y
|
__add
|
|
x + y
|
__sub
|
|
x - y
|
__len
|
#x
|
Matrix2.scale
Scales this matrix by the specified amount, changing the values inside. Returns self for chaining.
Matrix2.copy
Creates and returns a new copy of this matrix.
overload 1:
Matrix2:copy()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix2 | Matrix2
|
Matrix2.reset
Resets this matrix back to the identity matrix. Returns self for chaining.
overload 1:
Matrix2:reset()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix2 | Matrix2
|
Matrix2.det
Calculates and returns the determinant of this matrix.
overload 1:
Matrix2:det()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Matrix2.transposed
Returns a copy of this matrix, but transposed. Transposing means to swap the rows and the columns.
overload 1:
Matrix2:transposed()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix2 | Matrix2
|
Matrix2.inverted
Returns a copy of this matrix, but inverted.
overload 1:
Matrix2:inverted()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix2 | Matrix2
|
Matrix2.transpose
Transposes this matrix, changing the values inside. Transposing means to swap the rows and the columns. Returns self for chaining.
overload 1:
Matrix2:transpose()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix2 | Matrix2
|
Matrix2.augmented
Augments this matrix, adding an additional row and column. Puts a 1 along the diagonal in the new spot, and the rest are zero.
overload 1:
Matrix2:augmented()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix3 | Matrix3
|
Matrix2.invert
Inverts this matrix, changing the values inside. Returns self for chaining.
overload 1:
Matrix2:invert()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix2 | Matrix2
|
Matrix3
A matrix with 3 rows and 3 columns.
| Meta name | Allowed other parameters | Meta execution method |
|---|---|---|
__le
|
|
x <= y
|
__eq
|
|
x == y
|
__mul
|
|
x * y
|
__add
|
|
x + y
|
__sub
|
|
x - y
|
__len
|
#x
|
Matrix3.scale
Scales this matrix by the specified amount, changing the values inside. Returns self for chaining.
Matrix3.apply
Treats the given values as a vector, augments this vector with a 1, multiplies it against the matrix, and returns a deaugmented vector of the first values.
Matrix3.copy
Creates and returns a new copy of this matrix.
overload 1:
Matrix3:copy()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix3 | Matrix3
|
Matrix3.reset
Resets this matrix back to the identity matrix. Returns self for chaining.
overload 1:
Matrix3:reset()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix3 | Matrix3
|
Matrix3.rotate
Rotates this matrix by the specified amount, changing the values inside. Angles are given in degrees. Returns self for chaining.
Matrix3.det
Calculates and returns the determinant of this matrix.
overload 1:
Matrix3:det()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Matrix3.transposed
Returns a copy of this matrix, but transposed. Transposing means to swap the rows and the columns.
overload 1:
Matrix3:transposed()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix3 | Matrix3
|
Matrix3.inverted
Returns a copy of this matrix, but inverted.
overload 1:
Matrix3:inverted()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix3 | Matrix3
|
Matrix3.translate
Translates this matrix by the specified amount, changing the values inside. Returns self for chaining.
Matrix3.applyDir
Treats the given values as a vector, augments this vector with a 0, multiplies it against the matrix, and returns a deaugmented vector of the first values.
Matrix3.deaugmented
Deaugments this matrix, removing a row and column.
overload 1:
Matrix3:deaugmented()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix2 | Matrix2
|
Matrix3.transpose
Transposes this matrix, changing the values inside. Transposing means to swap the rows and the columns. Returns self for chaining.
overload 1:
Matrix3:transpose()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix3 | Matrix3
|
Matrix3.augmented
Augments this matrix, adding an additional row and column. Puts a 1 along the diagonal in the new spot, and the rest are zero.
overload 1:
Matrix3:augmented()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix4 | Matrix4
|
Matrix3.invert
Inverts this matrix, changing the values inside. Returns self for chaining.
overload 1:
Matrix3:invert()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix3 | Matrix3
|
Matrix4
A matrix with 4 rows and 4 columns.
| Meta name | Allowed other parameters | Meta execution method |
|---|---|---|
__le
|
|
x <= y
|
__eq
|
|
x == y
|
__mul
|
|
x * y
|
__add
|
|
x + y
|
__sub
|
|
x - y
|
__len
|
#x
|
Matrix4.scale
Scales this matrix by the specified amount, changing the values inside. Returns self for chaining.
Matrix4.apply
Treats the given values as a vector, augments this vector with a 1, multiplies it against the matrix, and returns a deaugmented vector of the first values.
Matrix4.copy
Creates and returns a new copy of this matrix.
overload 1:
Matrix4:copy()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix4 | Matrix4
|
Matrix4.reset
Resets this matrix back to the identity matrix. Returns self for chaining.
overload 1:
Matrix4:reset()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix4 | Matrix4
|
Matrix4.rotate
Rotates this matrix by the specified amount, changing the values inside. Angles are given in degrees. Returns self for chaining.
Matrix4.det
Calculates and returns the determinant of this matrix.
overload 1:
Matrix4:det()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Matrix4.transposed
Returns a copy of this matrix, but transposed. Transposing means to swap the rows and the columns.
overload 1:
Matrix4:transposed()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix4 | Matrix4
|
Matrix4.inverted
Returns a copy of this matrix, but inverted.
overload 1:
Matrix4:inverted()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix4 | Matrix4
|
Matrix4.translate
Translates this matrix by the specified amount, changing the values inside. Returns self for chaining.
Matrix4.applyDir
Treats the given values as a vector, augments this vector with a 0, multiplies it against the matrix, and returns a deaugmented vector of the first values.
Matrix4.deaugmented
Deaugments this matrix, removing a row and column.
overload 1:
Matrix4:deaugmented()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix3 | Matrix3
|
Matrix4.transpose
Transposes this matrix, changing the values inside. Transposing means to swap the rows and the columns. Returns self for chaining.
overload 1:
Matrix4:transpose()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix4 | Matrix4
|
Matrix4.invert
Inverts this matrix, changing the values inside. Returns self for chaining.
overload 1:
Matrix4:invert()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Matrix4 | Matrix4
|
NameplateCustomization
A customization that can be applied to a nameplate.
NameplateCustomization.getText
The text to use in this nameplate.
overload 1:
NameplateCustomization:getText()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
NameplateCustomizationGroup
A customization that holds another nameplate customizations.
Page
An Action Wheel container which is used to store up to 8 actions.
Page.newAction
Adds a new Click Action on the selected Page's index. If no index is given it is added in the first available index.
Page.newScroll
Adds a new Scroll Action on the selected Page's index. If no index is given it is added in the first available index.
Page.newToggle
Adds a new Toggle Action on the selected Page's index. If no index is given it is added in the first available index.
PingFunction
A custom function wrapped with networking data.
RenderTask
Represents a rendering task for Figura to complete each frame. An abstract superclass of ItemTask, BlockTask, and TextTask.
RenderTask.scale
The scale of the task, relative with its attached part.
overload 1:
RenderTask:scale(scale)
| Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | a Vector3 | Vector3
|
| Return Value | a RenderTask | RenderTask
|
overload 2:
RenderTask:scale(x, y, z)
| Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a number | Number
|
| y accepts | a number | Number
|
| z accepts | a number | Number
|
| Return Value | a RenderTask | RenderTask
|
RenderTask.enabled
Whether or not this task should be rendered.
overload 1:
RenderTask:enabled(bool)
| Method Property | Fluent Description | Representation |
|---|---|---|
| bool accepts | a Boolean | Boolean
|
| Return Value | a RenderTask | RenderTask
|
RenderTask.pos
The position of the task, relative with its attached part. Uses model coordinates.
overload 1:
RenderTask:pos(pos)
| Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | Vector3
|
| Return Value | a RenderTask | RenderTask
|
overload 2:
RenderTask:pos(x, y, z)
| Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a number | Number
|
| y accepts | a number | Number
|
| z accepts | a number | Number
|
| Return Value | a RenderTask | RenderTask
|
RenderTask.isEnabled
Checks if this task is enabled.
overload 1:
RenderTask:isEnabled()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
RenderTask.emissive
Whether or not this task should be rendered at full bright.
overload 1:
RenderTask:emissive(bool)
| Method Property | Fluent Description | Representation |
|---|---|---|
| bool accepts | a Boolean | Boolean
|
| Return Value | a RenderTask | RenderTask
|
RenderTask.isEmissive
Checks if this task is emissive.
overload 1:
RenderTask:isEmissive()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
RenderTask.getScale
Gets this task scale.
overload 1:
RenderTask:getScale()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
RenderTask.getPos
Gets this task position.
overload 1:
RenderTask:getPos()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
RenderTask.getRot
Gets this task rotation.
overload 1:
RenderTask:getRot()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
RenderTask.rot
The rotation of the task, relative with its attached part.
overload 1:
RenderTask:rot(rot)
| Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | a Vector3 | Vector3
|
| Return Value | a RenderTask | RenderTask
|
overload 2:
RenderTask:rot(x, y, z)
| Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a number | Number
|
| y accepts | a number | Number
|
| z accepts | a number | Number
|
| Return Value | a RenderTask | RenderTask
|
ScrollAction.color
Inherited from Action
Sets the color of the Action. Returns the Action for function chaining.
ScrollAction.item
Inherited from Action
Sets the item of the Action. Returns the Action for function chaining.
ScrollAction.title
Inherited from Action
Sets the title of the Action. Returns the Action for function chaining.
ScrollAction.getTitle
Inherited from Action
Gets this Action title.
overload 1:
ScrollAction:getTitle()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ScrollAction.getHoverColor
Inherited from Action
Gets this Action hover color.
overload 1:
ScrollAction:getHoverColor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
ScrollAction.hoverColor
Inherited from Action
Sets the color of the Action when it is being hovered. Returns the Action for function chaining.
ScrollAction.hoverItem
Inherited from Action
Sets the item of the Action when it is being hovered. Returns the Action for function chaining.
ScrollAction.getColor
Inherited from Action
Gets this Action color.
overload 1:
ScrollAction:getColor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
ScrollAction.scroll
Function that is executed when the mouse is scrolled.
field signature:
scroll
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Function | Function
|
Sound
Represents a sound that can be played. Obtained by indexing the SoundAPI. Exists as an object-oriented alternative to sounds:playSound().
Sound.play
Plays this sound with the given parameters. Volume in Minecraft refers to how far away people can hear from, not the actual loudness. The defaults for volume and pitch are 1.
overload 4:
Sound:play(posX, posY, posZ, volume, pitch, loop)
TextTask.text
Sets the Text for this task render.
overload 1:
TextTask:text(text)
| Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | a string | String
|
| Return Value | a RenderTask | RenderTask
|
TextTask.shadow
Toggles if the Text should render with a drop shadow. Not compatible with "Outline" mode
overload 1:
TextTask:shadow(shadow)
| Method Property | Fluent Description | Representation |
|---|---|---|
| shadow accepts | a Boolean | Boolean
|
| Return Value | a RenderTask | RenderTask
|
TextTask.outline
Toggles if the Text should render with a outline. Always renders at full bright. Not compatible with "Shadow" and "Emissive" modes
overload 1:
TextTask:outline(outline)
| Method Property | Fluent Description | Representation |
|---|---|---|
| outline accepts | a Boolean | Boolean
|
| Return Value | a RenderTask | RenderTask
|
TextTask.isCentred
Checks if this task text will render centred.
overload 1:
TextTask:isCentred()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
TextTask.centered
Toggles if the Text should render centered on this task pivot point.
overload 1:
TextTask:centered(centered)
| Method Property | Fluent Description | Representation |
|---|---|---|
| centered accepts | a Boolean | Boolean
|
| Return Value | a RenderTask | RenderTask
|
TextTask.outlineColor
Sets the outline color this Text should render. Only compatible with "Outline" mode
TextTask.getOutlineColor
Gets this tasks text outline color.
overload 1:
TextTask:getOutlineColor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
TextTask.hasShadow
Checks if this task text has shadow.
overload 1:
TextTask:hasShadow()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
TextTask.hasOutline
Checks if this task text has outline.
overload 1:
TextTask:hasOutline()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
TextTask.scale
Inherited from RenderTask
The scale of the task, relative with its attached part.
overload 1:
TextTask:scale(scale)
| Method Property | Fluent Description | Representation |
|---|---|---|
| scale accepts | a Vector3 | Vector3
|
| Return Value | a RenderTask | RenderTask
|
overload 2:
TextTask:scale(x, y, z)
| Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a number | Number
|
| y accepts | a number | Number
|
| z accepts | a number | Number
|
| Return Value | a RenderTask | RenderTask
|
TextTask.enabled
Inherited from RenderTask
Whether or not this task should be rendered.
overload 1:
TextTask:enabled(bool)
| Method Property | Fluent Description | Representation |
|---|---|---|
| bool accepts | a Boolean | Boolean
|
| Return Value | a RenderTask | RenderTask
|
TextTask.pos
Inherited from RenderTask
The position of the task, relative with its attached part. Uses model coordinates.
overload 1:
TextTask:pos(pos)
| Method Property | Fluent Description | Representation |
|---|---|---|
| pos accepts | a Vector3 | Vector3
|
| Return Value | a RenderTask | RenderTask
|
overload 2:
TextTask:pos(x, y, z)
| Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a number | Number
|
| y accepts | a number | Number
|
| z accepts | a number | Number
|
| Return Value | a RenderTask | RenderTask
|
TextTask.isEnabled
Inherited from RenderTask
Checks if this task is enabled.
overload 1:
TextTask:isEnabled()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
TextTask.emissive
Inherited from RenderTask
Whether or not this task should be rendered at full bright.
overload 1:
TextTask:emissive(bool)
| Method Property | Fluent Description | Representation |
|---|---|---|
| bool accepts | a Boolean | Boolean
|
| Return Value | a RenderTask | RenderTask
|
TextTask.isEmissive
Inherited from RenderTask
Checks if this task is emissive.
overload 1:
TextTask:isEmissive()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
TextTask.getScale
Inherited from RenderTask
Gets this task scale.
overload 1:
TextTask:getScale()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
TextTask.getPos
Inherited from RenderTask
Gets this task position.
overload 1:
TextTask:getPos()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
TextTask.getRot
Inherited from RenderTask
Gets this task rotation.
overload 1:
TextTask:getRot()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
TextTask.rot
Inherited from RenderTask
The rotation of the task, relative with its attached part.
overload 1:
TextTask:rot(rot)
| Method Property | Fluent Description | Representation |
|---|---|---|
| rot accepts | a Vector3 | Vector3
|
| Return Value | a RenderTask | RenderTask
|
overload 2:
TextTask:rot(x, y, z)
| Method Property | Fluent Description | Representation |
|---|---|---|
| x accepts | a number | Number
|
| y accepts | a number | Number
|
| z accepts | a number | Number
|
| Return Value | a RenderTask | RenderTask
|
ToggleAction.isToggled
Checks if the Action is toggled or not.
overload 1:
ToggleAction:isToggled()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
ToggleAction.toggleItem
Sets the item of the Action when it is toggled. Returns the Action for function chaining.
ToggleAction.getToggleColor
Gets this Action toggled color.
overload 1:
ToggleAction:getToggleColor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
ToggleAction.toggleColor
Sets the color of the Action when it is toggled. Returns the Action for function chaining.
ToggleAction.getToggleTitle
Gets this Action toggled title.
overload 1:
ToggleAction:getToggleTitle()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a string | String
|
ToggleAction.color
Inherited from Action
Sets the color of the Action. Returns the Action for function chaining.
ToggleAction.item
Inherited from Action
Sets the item of the Action. Returns the Action for function chaining.
ToggleAction.title
Inherited from Action
Sets the title of the Action. Returns the Action for function chaining.
ToggleAction.getHoverColor
Inherited from Action
Gets this Action hover color.
overload 1:
ToggleAction:getHoverColor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
ToggleAction.hoverColor
Inherited from Action
Sets the color of the Action when it is being hovered. Returns the Action for function chaining.
ToggleAction.hoverItem
Inherited from Action
Sets the item of the Action when it is being hovered. Returns the Action for function chaining.
ToggleAction.getColor
Inherited from Action
Gets this Action color.
overload 1:
ToggleAction:getColor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
ToggleAction.toggle
Function that is executed when the Action is toggled.
field signature:
toggle
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Function | Function
|
ToggleAction.untoggle
Function that is executed when the Action is untoggled.
field signature:
untoggle
| Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | a Function | Function
|
VanillaModelGroup
Represents a group of model parts in a vanilla model. Used for easy reference of normal parts. Can only be set visible and invisible.
VanillaModelGroup.getVisible
Gets whether you have set this parts to be visible or invisible. Only responds to your own changes in script, not anything done by Minecraft.
overload 1:
VanillaModelGroup:getVisible()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
VanillaModelPart
Represents a model part in a vanilla model. Can be set visible and invisible, and queried for rotation and position offsets.
VanillaModelPart.getVisible
Gets whether you have set this part to be visible or invisible. Only responds to your own changes in script, not anything done by Minecraft.
overload 1:
VanillaModelPart:getVisible()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Boolean | Boolean
|
VanillaModelPart.getOriginRot
Gets the rotation to this vanilla model part currently applied by Minecraft.
overload 1:
VanillaModelPart:getOriginRot()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
VanillaModelPart.getOriginPos
Gets the position offset to this vanilla model part currently applied by Minecraft.
overload 1:
VanillaModelPart:getOriginPos()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
Vector2
A vector that holds 2 numbers. Can be created using functions in the "vectors" api.
| Meta name | Allowed other parameters | Meta execution method |
|---|---|---|
__le
|
|
x <= y
|
__lt
|
|
x < y
|
__len
|
#x
|
|
__unm
|
-x
|
|
__eq
|
|
x == y
|
__mod
|
|
x % y
|
__div
|
|
x / y
|
__mul
|
|
x * y
|
__add
|
|
x + y
|
__sub
|
|
x - y
|
Vector2.add
Adds the given vector or values to this one, and returns self for chaining.
Vector2.length
Returns the length of this vector.
overload 1:
Vector2:length()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Vector2.floor
Returns a copy of this vector with its values rounded down.
overload 1:
Vector2:floor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector2 | Vector2
|
Vector2.ceil
Returns a copy of this vector with its values rounded up.
overload 1:
Vector2:ceil()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector2 | Vector2
|
Vector2.set
Sets this vector to have the given values. Nil values are treated as zero. Returns self for chaining.
Vector2.copy
Creates and returns a copy of this vector.
overload 1:
Vector2:copy()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector2 | Vector2
|
Vector2.normalize
Modifies this vector so that its length is 1, unless its length was originally 0. Returns self for chaining.
overload 1:
Vector2:normalize()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector2 | Vector2
|
Vector2.reset
Resets this vector back to being all zeroes, and returns itself for chaining.
overload 1:
Vector2:reset()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector2 | Vector2
|
Vector2.reduce
Reduces this vector modulo the given vector or values, and returns self for chaining.
Vector2.normalized
Returns a copy of this vector with length 1, unless its length was originally 0.
overload 1:
Vector2:normalized()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector2 | Vector2
|
Vector2.sub
Subtracts the given vector or values from this one, and returns self for chaining.
Vector2.mul
Multiplies the given vector or values into this one, and returns self for chaining.
Vector2.div
Divides this vector by the given vector or values, and returns self for chaining.
Vector2.clamped
Returns a modified copy of this vector, with its length clamped from minLength to maxLength. If the vector has length zero, then the copy does too.
Vector2.lengthSquared
Returns the length of this vector squared. Suitable when you only care about relative lengths, because it avoids a square root.
overload 1:
Vector2:lengthSquared()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Vector2.toDeg
Returns a copy of this vector, in degrees.
overload 1:
Vector2:toDeg()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector2 | Vector2
|
Vector2.clampLength
Modifies this vector so that its length is between minLength and maxLength. If the vector has length zero, it is unmodified. Returns self for chaining.
Vector2.toRad
Returns a copy of this vector, in radians.
overload 1:
Vector2:toRad()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector2 | Vector2
|
Vector3
A vector that holds 3 numbers. Can be created using functions in the "vectors" api.
| Meta name | Allowed other parameters | Meta execution method |
|---|---|---|
__le
|
|
x <= y
|
__lt
|
|
x < y
|
__len
|
#x
|
|
__unm
|
-x
|
|
__eq
|
|
x == y
|
__mod
|
|
x % y
|
__div
|
|
x / y
|
__mul
|
|
x * y
|
__add
|
|
x + y
|
__sub
|
|
x - y
|
Vector3.add
Adds the given vector or values to this one, and returns self for chaining.
Vector3.length
Returns the length of this vector.
overload 1:
Vector3:length()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Vector3.floor
Returns a copy of this vector with its values rounded down.
overload 1:
Vector3:floor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
Vector3.ceil
Returns a copy of this vector with its values rounded up.
overload 1:
Vector3:ceil()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
Vector3.set
Sets this vector to have the given values. Nil values are treated as zero. Returns self for chaining.
Vector3.copy
Creates and returns a copy of this vector.
overload 1:
Vector3:copy()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
Vector3.normalize
Modifies this vector so that its length is 1, unless its length was originally 0. Returns self for chaining.
overload 1:
Vector3:normalize()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
Vector3.reset
Resets this vector back to being all zeroes, and returns itself for chaining.
overload 1:
Vector3:reset()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
Vector3.reduce
Reduces this vector modulo the given vector or values, and returns self for chaining.
Vector3.normalized
Returns a copy of this vector with length 1, unless its length was originally 0.
overload 1:
Vector3:normalized()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
Vector3.sub
Subtracts the given vector or values from this one, and returns self for chaining.
Vector3.mul
Multiplies the given vector or values into this one, and returns self for chaining.
Vector3.div
Divides this vector by the given vector or values, and returns self for chaining.
Vector3.clamped
Returns a modified copy of this vector, with its length clamped from minLength to maxLength. If the vector has length zero, then the copy does too.
Vector3.lengthSquared
Returns the length of this vector squared. Suitable when you only care about relative lengths, because it avoids a square root.
overload 1:
Vector3:lengthSquared()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Vector3.toDeg
Returns a copy of this vector, in degrees.
overload 1:
Vector3:toDeg()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
Vector3.augmented
Returns the augmented form of this vector. The augmented form is Vector4 with a 1 in its W coordinate.
overload 1:
Vector3:augmented()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector4 | Vector4
|
Vector3.clampLength
Modifies this vector so that its length is between minLength and maxLength. If the vector has length zero, it is unmodified. Returns self for chaining.
Vector3.toRad
Returns a copy of this vector, in radians.
overload 1:
Vector3:toRad()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector3 | Vector3
|
Vector4
A vector that holds 4 numbers. Can be created using functions in the "vectors" api.
| Meta name | Allowed other parameters | Meta execution method |
|---|---|---|
__le
|
|
x <= y
|
__lt
|
|
x < y
|
__len
|
#x
|
|
__unm
|
-x
|
|
__eq
|
|
x == y
|
__mod
|
|
x % y
|
__div
|
|
x / y
|
__mul
|
|
x * y
|
__add
|
|
x + y
|
__sub
|
|
x - y
|
Vector4.add
Adds the given vector or values to this one, and returns self for chaining.
Vector4.length
Returns the length of this vector.
overload 1:
Vector4:length()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Vector4.floor
Returns a copy of this vector with its values rounded down.
overload 1:
Vector4:floor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector4 | Vector4
|
Vector4.ceil
Returns a copy of this vector with its values rounded up.
overload 1:
Vector4:ceil()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector4 | Vector4
|
Vector4.set
Sets this vector to have the given values. Nil values are treated as zero. Returns self for chaining.
Vector4.copy
Creates and returns a copy of this vector.
overload 1:
Vector4:copy()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector4 | Vector4
|
Vector4.normalize
Modifies this vector so that its length is 1, unless its length was originally 0. Returns self for chaining.
overload 1:
Vector4:normalize()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector4 | Vector4
|
Vector4.reset
Resets this vector back to being all zeroes, and returns itself for chaining.
overload 1:
Vector4:reset()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector4 | Vector4
|
Vector4.reduce
Reduces this vector modulo the given vector or values, and returns self for chaining.
Vector4.normalized
Returns a copy of this vector with length 1, unless its length was originally 0.
overload 1:
Vector4:normalized()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector4 | Vector4
|
Vector4.sub
Subtracts the given vector or values from this one, and returns self for chaining.
Vector4.mul
Multiplies the given vector or values into this one, and returns self for chaining.
Vector4.div
Divides this vector by the given vector or values, and returns self for chaining.
Vector4.clamped
Returns a modified copy of this vector, with its length clamped from minLength to maxLength. If the vector has length zero, then the copy does too.
Vector4.lengthSquared
Returns the length of this vector squared. Suitable when you only care about relative lengths, because it avoids a square root.
overload 1:
Vector4:lengthSquared()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Vector4.toDeg
Returns a copy of this vector, in degrees.
overload 1:
Vector4:toDeg()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector4 | Vector4
|
Vector4.clampLength
Modifies this vector so that its length is between minLength and maxLength. If the vector has length zero, it is unmodified. Returns self for chaining.
Vector4.toRad
Returns a copy of this vector, in radians.
overload 1:
Vector4:toRad()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector4 | Vector4
|
Vector5
A vector that holds 5 numbers. Can be created using functions in the "vectors" api.
| Meta name | Allowed other parameters | Meta execution method |
|---|---|---|
__le
|
|
x <= y
|
__lt
|
|
x < y
|
__len
|
#x
|
|
__unm
|
-x
|
|
__eq
|
|
x == y
|
__mod
|
|
x % y
|
__div
|
|
x / y
|
__mul
|
|
x * y
|
__add
|
|
x + y
|
__sub
|
|
x - y
|
Vector5.add
Adds the given vector or values to this one, and returns self for chaining.
Vector5.length
Returns the length of this vector.
overload 1:
Vector5:length()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Vector5.floor
Returns a copy of this vector with its values rounded down.
overload 1:
Vector5:floor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector5 | Vector5
|
Vector5.ceil
Returns a copy of this vector with its values rounded up.
overload 1:
Vector5:ceil()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector5 | Vector5
|
Vector5.set
Sets this vector to have the given values. Nil values are treated as zero. Returns self for chaining.
Vector5.copy
Creates and returns a copy of this vector.
overload 1:
Vector5:copy()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector5 | Vector5
|
Vector5.normalize
Modifies this vector so that its length is 1, unless its length was originally 0. Returns self for chaining.
overload 1:
Vector5:normalize()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector5 | Vector5
|
Vector5.reset
Resets this vector back to being all zeroes, and returns itself for chaining.
overload 1:
Vector5:reset()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector5 | Vector5
|
Vector5.reduce
Reduces this vector modulo the given vector or values, and returns self for chaining.
Vector5.normalized
Returns a copy of this vector with length 1, unless its length was originally 0.
overload 1:
Vector5:normalized()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector5 | Vector5
|
Vector5.sub
Subtracts the given vector or values from this one, and returns self for chaining.
Vector5.mul
Multiplies the given vector or values into this one, and returns self for chaining.
Vector5.div
Divides this vector by the given vector or values, and returns self for chaining.
Vector5.clamped
Returns a modified copy of this vector, with its length clamped from minLength to maxLength. If the vector has length zero, then the copy does too.
Vector5.lengthSquared
Returns the length of this vector squared. Suitable when you only care about relative lengths, because it avoids a square root.
overload 1:
Vector5:lengthSquared()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Vector5.toDeg
Returns a copy of this vector, in degrees.
overload 1:
Vector5:toDeg()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector5 | Vector5
|
Vector5.clampLength
Modifies this vector so that its length is between minLength and maxLength. If the vector has length zero, it is unmodified. Returns self for chaining.
Vector5.toRad
Returns a copy of this vector, in radians.
overload 1:
Vector5:toRad()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector5 | Vector5
|
Vector6
A vector that holds 6 numbers. Can be created using functions in the "vectors" api.
| Meta name | Allowed other parameters | Meta execution method |
|---|---|---|
__le
|
|
x <= y
|
__lt
|
|
x < y
|
__len
|
#x
|
|
__unm
|
-x
|
|
__eq
|
|
x == y
|
__mod
|
|
x % y
|
__div
|
|
x / y
|
__mul
|
|
x * y
|
__add
|
|
x + y
|
__sub
|
|
x - y
|
Vector6.add
Adds the given vector or values to this one, and returns self for chaining.
Vector6.length
Returns the length of this vector.
overload 1:
Vector6:length()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Vector6.floor
Returns a copy of this vector with its values rounded down.
overload 1:
Vector6:floor()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector6 | Vector6
|
Vector6.ceil
Returns a copy of this vector with its values rounded up.
overload 1:
Vector6:ceil()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector6 | Vector6
|
Vector6.set
Sets this vector to have the given values. Nil values are treated as zero. Returns self for chaining.
Vector6.copy
Creates and returns a copy of this vector.
overload 1:
Vector6:copy()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector6 | Vector6
|
Vector6.normalize
Modifies this vector so that its length is 1, unless its length was originally 0. Returns self for chaining.
overload 1:
Vector6:normalize()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector6 | Vector6
|
Vector6.reset
Resets this vector back to being all zeroes, and returns itself for chaining.
overload 1:
Vector6:reset()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector6 | Vector6
|
Vector6.reduce
Reduces this vector modulo the given vector or values, and returns self for chaining.
Vector6.normalized
Returns a copy of this vector with length 1, unless its length was originally 0.
overload 1:
Vector6:normalized()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector6 | Vector6
|
Vector6.sub
Subtracts the given vector or values from this one, and returns self for chaining.
Vector6.mul
Multiplies the given vector or values into this one, and returns self for chaining.
Vector6.div
Divides this vector by the given vector or values, and returns self for chaining.
Vector6.clamped
Returns a modified copy of this vector, with its length clamped from minLength to maxLength. If the vector has length zero, then the copy does too.
Vector6.lengthSquared
Returns the length of this vector squared. Suitable when you only care about relative lengths, because it avoids a square root.
overload 1:
Vector6:lengthSquared()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a number | Number
|
Vector6.toDeg
Returns a copy of this vector, in degrees.
overload 1:
Vector6:toDeg()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector6 | Vector6
|
Vector6.clampLength
Modifies this vector so that its length is between minLength and maxLength. If the vector has length zero, it is unmodified. Returns self for chaining.
Vector6.toRad
Returns a copy of this vector, in radians.
overload 1:
Vector6:toRad()
| Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | a Vector6 | Vector6
|
math
Contains functions which Figura adds to the default Lua "math" library table.
math.map
Maps the given value from one range to another. For example, if you have a value of 20 in the range 0-200, and you want to map it to the range 100-200, the result will be 110.
math.lerp
Linearly interpolates from its first argument to its second argument, with the third argument as the parameter. Works on both regular numbers and vectors.
math.shortAngle
Returns the shortest angle between two angles. For example, if you have an angle of 350 degrees and you want to get the shortest angle between it and 0 degrees, the result will be 10 degrees.
math.lerpAngle
Similar to the default lerp function, but numbers are limited to the range of 0-360. Lerp is done towards the shortest angle. For example, a lerp of 340 and 20, with factor of 0.75, will return 310.
Colors
List of custom colors. Used anywhere you can input a hex color.
FRAN_PINK
fran
francielly
bunny
CHLOE_PURPLE
chloe
space
MAYA_BLUE
maya
devnull
SKYE_BLUE
sky
skye
skylar
LILY_RED
lily
foxes
fox
CHEESE
largecheese
large cheese
LUA_LOG
LUA_ERROR
LUA_PING
luna
moff
moth
DEFAULT
DISCORD
EntityPoses
List of valid EntityPoses. Used within the EntityAPI.
STANDING
FALL_FLYING
SLEEPING
SWIMMING
SPIN_ATTACK
CROUCHING
LONG_JUMPING
DYING
CROAKING
USING_TONGUE
ROARING
SNIFFING
EMERGING
DIGGING
ItemRenderTypes
List of valid RenderTypes. Used within the Item RenderTask.
NONE
THIRD_PERSON_LEFT_HAND
THIRD_PERSON_RIGHT_HAND
FIRST_PERSON_LEFT_HAND
FIRST_PERSON_RIGHT_HAND
HEAD
GUI
GROUND
FIXED
KeyIDs
List of valid KeyIDs. Used within the KeybindAPI.
key.playerlist
figura.config.action_wheel_button
key.sneak
key.hotbar.8
key.hotbar.7
key.sprint
key.hotbar.6
key.hotbar.5
key.hotbar.4
key.hotbar.3
key.hotbar.2
key.togglePerspective
key.hotbar.1
key.spectatorOutlines
key.left
key.chat
key.pickItem
key.socialInteractions
key.fullscreen
key.attack
key.smoothCamera
key.advancements
figura.config.popup_button
key.use
figura.config.panic_button
key.loadToolbarActivator
figura.config.reload_button
key.hotbar.9
key.forward
key.right
key.screenshot
key.back
key.swapOffhand
key.command
key.saveToolbarActivator
key.inventory
key.jump
key.drop
Keybinds
List of valid keybind keys. Used within the KeybindAPI.
key.keyboard.unknown
key.mouse.left
key.mouse.right
key.mouse.middle
key.mouse.4
key.mouse.5
key.mouse.6
key.mouse.7
key.mouse.8
key.keyboard.0
key.keyboard.1
key.keyboard.2
key.keyboard.3
key.keyboard.4
key.keyboard.5
key.keyboard.6
key.keyboard.7
key.keyboard.8
key.keyboard.9
key.keyboard.a
key.keyboard.b
key.keyboard.c
key.keyboard.d
key.keyboard.e
key.keyboard.f
key.keyboard.g
key.keyboard.h
key.keyboard.i
key.keyboard.j
key.keyboard.k
key.keyboard.l
key.keyboard.m
key.keyboard.n
key.keyboard.o
key.keyboard.p
key.keyboard.q
key.keyboard.r
key.keyboard.s
key.keyboard.t
key.keyboard.u
key.keyboard.v
key.keyboard.w
key.keyboard.x
key.keyboard.y
key.keyboard.z
key.keyboard.f1
key.keyboard.f2
key.keyboard.f3
key.keyboard.f4
key.keyboard.f5
key.keyboard.f6
key.keyboard.f7
key.keyboard.f8
key.keyboard.f9
key.keyboard.f10
key.keyboard.f11
key.keyboard.f12
key.keyboard.f13
key.keyboard.f14
key.keyboard.f15
key.keyboard.f16
key.keyboard.f17
key.keyboard.f18
key.keyboard.f19
key.keyboard.f20
key.keyboard.f21
key.keyboard.f22
key.keyboard.f23
key.keyboard.f24
key.keyboard.f25
key.keyboard.num.lock
key.keyboard.keypad.0
key.keyboard.keypad.1
key.keyboard.keypad.2
key.keyboard.keypad.3
key.keyboard.keypad.4
key.keyboard.keypad.5
key.keyboard.keypad.6
key.keyboard.keypad.7
key.keyboard.keypad.8
key.keyboard.keypad.9
key.keyboard.keypad.add
key.keyboard.keypad.decimal
key.keyboard.keypad.enter
key.keyboard.keypad.equal
key.keyboard.keypad.multiply
key.keyboard.keypad.divide
key.keyboard.keypad.subtract
key.keyboard.down
key.keyboard.left
key.keyboard.right
key.keyboard.up
key.keyboard.apostrophe
key.keyboard.backslash
key.keyboard.comma
key.keyboard.equal
key.keyboard.grave.accent
key.keyboard.left.bracket
key.keyboard.minus
key.keyboard.period
key.keyboard.right.bracket
key.keyboard.semicolon
key.keyboard.slash
key.keyboard.space
key.keyboard.tab
key.keyboard.left.alt
key.keyboard.left.control
key.keyboard.left.shift
key.keyboard.left.win
key.keyboard.right.alt
key.keyboard.right.control
key.keyboard.right.shift
key.keyboard.right.win
key.keyboard.enter
key.keyboard.escape
key.keyboard.backspace
key.keyboard.delete
key.keyboard.end
key.keyboard.home
key.keyboard.insert
key.keyboard.page.down
key.keyboard.page.up
key.keyboard.caps.lock
key.keyboard.pause
key.keyboard.scroll.lock
key.keyboard.menu
key.keyboard.print.screen
key.keyboard.world.1
key.keyboard.world.2
LoopModes
List of valid LoopModes. Used within Blockbench animations.
LOOP
ONCE
HOLD
ParentTypes
List of valid ParentTypes. Used within ModelParts.
None
NONE
Head
HEAD
Body
BODY
LeftArm
LEFT_ARM
RightArm
RIGHT_ARM
LeftLeg
LEFT_LEG
RightLeg
RIGHT_LEG
LeftElytra
LEFT_ELYTRA
LeftElytron
LEFT_ELYTRON
RightElytra
RIGHT_ELYTRA
RightElytron
RIGHT_ELYTRON
Cape
CAPE
World
WORLD
Hud
HUD
Gui
GUI
Camera
CAMERA
Skull
SKULL
?
LeftItemPivot
LEFT_ITEM_PIVOT
RightItemPivot
RIGHT_ITEM_PIVOT
LeftSpyglassPivot
LEFT_SPYGLASS_PIVOT
RightSpyglassPivot
RIGHT_SPYGLASS_PIVOT
HelmetItemPivot
HELMET_ITEM_PIVOT
LeftParrotPivot
LEFT_PARROT_PIVOT
RightParrotPivot
RIGHT_PARROT_PIVOT
PlayStates
List of valid PlayStates. Used within Blockbench animations.
STOPPED
PAUSED
PLAYING
PostEffects
List of valid PostEffects. Used within the RendererAPI.
notch
fxaa
art
bumpy
blobs2
pencil
color_convolve
deconverge
flip
invert
ntsc
outline
phosphor
scan_pincushion
sobel
bits
desaturate
green
blur
wobble
blobs
antialias
creeper
spider
RenderTypes
List of valid RenderTypes. Used within ModelParts.
CUTOUT
CUTOUT_CULL
TRANSLUCENT
TRANSLUCENT_CULL
EMISSIVE
EMISSIVE_SOLID
END_PORTAL
END_GATEWAY
GLINT
GLINT2
LINES
LINES_STRIP
TextureTypes
List of valid TextureTypes. Used within ModelParts.
SKIN
CAPE
ELYTRA
RESOURCE
PRIMARY
SECONDARY